@portabletext/editor 2.21.2 → 3.0.0

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

@@ -1,189 +0,0 @@
-import type {PortableTextBlock} from '@sanity/types'
-import {describe, expect, test} from 'vitest'
-import type {EditorSelector} from '../editor/editor-selector'
-import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
-import {defaultKeyGenerator} from '../utils/key-generator'
-import {getListIndex} from './selector.get-list-state'
-
-function blockObject(_key: string, name: string) {
-  return {
-    _key,
-    _type: name,
-  }
-}
-
-function textBlock(
-  _key: string,
-  {
-    listItem,
-    level,
-  }: {
-    listItem?: 'bullet' | 'number'
-    level?: number
-  },
-): PortableTextBlock {
-  return {
-    _key,
-    _type: 'block',
-    children: [
-      {
-        _key: defaultKeyGenerator(),
-        _type: 'span',
-        text: `${listItem}-${level}`,
-      },
-    ],
-    style: 'normal',
-    level,
-    listItem,
-  }
-}
-
-function createSnapshot(value: Array<PortableTextBlock>) {
-  return createTestSnapshot({
-    context: {
-      value,
-    },
-  })
-}
-
-function getListStates(
-  paths: Array<[{_key: string}]>,
-): EditorSelector<Array<number | undefined>> {
-  return (snapshot) => {
-    return paths.map((path) => getListIndex({path})(snapshot))
-  }
-}
-
-describe(getListIndex.name, () => {
-  test('empty', () => {
-    const snapshot = createSnapshot([])
-
-    expect(getListIndex({path: [{_key: 'k0'}]})(snapshot)).toEqual(undefined)
-  })
-
-  test('single list item', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 1}),
-    ])
-
-    expect(getListIndex({path: [{_key: 'k0'}]})(snapshot)).toEqual(1)
-  })
-
-  test('single indented list item', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 2}),
-    ])
-
-    expect(getListIndex({path: [{_key: 'k0'}]})(snapshot)).toEqual(1)
-  })
-
-  test('two lists broken up by a paragraph', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 1}),
-      textBlock('k1', {listItem: 'number', level: 1}),
-      textBlock('k2', {}),
-      textBlock('k3', {listItem: 'number', level: 1}),
-      textBlock('k4', {listItem: 'number', level: 1}),
-    ])
-
-    expect(
-      getListStates([
-        [{_key: 'k0'}],
-        [{_key: 'k1'}],
-        [{_key: 'k2'}],
-        [{_key: 'k3'}],
-        [{_key: 'k4'}],
-      ])(snapshot),
-    ).toEqual([1, 2, undefined, 1, 2])
-  })
-
-  test('two lists broken up by an image', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 1}),
-      textBlock('k1', {listItem: 'number', level: 1}),
-      blockObject('k2', 'image'),
-      textBlock('k3', {listItem: 'number', level: 1}),
-      textBlock('k4', {listItem: 'number', level: 1}),
-    ])
-
-    expect(
-      getListStates([
-        [{_key: 'k0'}],
-        [{_key: 'k1'}],
-        [{_key: 'k2'}],
-        [{_key: 'k3'}],
-        [{_key: 'k4'}],
-      ])(snapshot),
-    ).toEqual([1, 2, undefined, 1, 2])
-  })
-
-  test('numbered lists broken up by a bulleted list', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 1}),
-      textBlock('k1', {listItem: 'bullet', level: 1}),
-      textBlock('k2', {listItem: 'number', level: 1}),
-    ])
-
-    expect(
-      getListStates([[{_key: 'k0'}], [{_key: 'k1'}], [{_key: 'k2'}]])(snapshot),
-    ).toEqual([1, 1, 1])
-  })
-
-  test('simple indented list', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 1}),
-      textBlock('k1', {listItem: 'number', level: 2}),
-      textBlock('k2', {listItem: 'number', level: 2}),
-      textBlock('k3', {listItem: 'number', level: 1}),
-    ])
-
-    expect(
-      getListStates([
-        [{_key: 'k0'}],
-        [{_key: 'k1'}],
-        [{_key: 'k2'}],
-        [{_key: 'k3'}],
-      ])(snapshot),
-    ).toEqual([1, 1, 2, 2])
-  })
-
-  test('reverse indented list', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 2}),
-      textBlock('k1', {listItem: 'number', level: 1}),
-      textBlock('k2', {listItem: 'number', level: 2}),
-    ])
-
-    expect(
-      getListStates([[{_key: 'k0'}], [{_key: 'k1'}], [{_key: 'k2'}]])(snapshot),
-    ).toEqual([1, 1, 1])
-  })
-
-  test('complex list', () => {
-    const snapshot = createSnapshot([
-      textBlock('k0', {listItem: 'number', level: 1}),
-      textBlock('k1', {listItem: 'number', level: 3}),
-      textBlock('k2', {listItem: 'number', level: 2}),
-      textBlock('k3', {listItem: 'number', level: 3}),
-      textBlock('k4', {listItem: 'number', level: 1}),
-      textBlock('k5', {listItem: 'number', level: 3}),
-      textBlock('k6', {listItem: 'number', level: 4}),
-      textBlock('k7', {listItem: 'number', level: 3}),
-      textBlock('k8', {listItem: 'number', level: 1}),
-    ])
-
-    expect(
-      getListStates([
-        [{_key: 'k0'}],
-        [{_key: 'k1'}],
-        [{_key: 'k2'}],
-        [{_key: 'k3'}],
-        [{_key: 'k4'}],
-        [{_key: 'k5'}],
-        [{_key: 'k6'}],
-        [{_key: 'k7'}],
-        [{_key: 'k8'}],
-      ])(snapshot),
-    ).toEqual([1, 1, 1, 1, 2, 1, 1, 2, 3])
-  })
-})

package/src/selectors/selector.get-list-state.ts

@@ -1,96 +0,0 @@
-import {isTextBlock} from '@portabletext/schema'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-import {getFocusTextBlock} from './selector.get-focus-text-block'
-
-/**
- * @beta
- * @deprecated Use the precomputed `data-list-index` on text blocks instead.
- * Given the `path` of a block, this selector will return the "list index" of
- * the block.
- */
-export function getListIndex({
-  path,
-}: {
-  path: BlockPath
-}): EditorSelector<number | undefined> {
-  return (snapshot) => {
-    const selection = {
-      anchor: {
-        path,
-        offset: 0,
-      },
-      focus: {
-        path,
-        offset: 0,
-      },
-    }
-
-    const focusTextBlock = getFocusTextBlock({
-      ...snapshot,
-      context: {
-        ...snapshot.context,
-        selection,
-      },
-    })
-
-    if (!focusTextBlock) {
-      return undefined
-    }
-
-    if (
-      focusTextBlock.node.listItem === undefined ||
-      focusTextBlock.node.level === undefined
-    ) {
-      return undefined
-    }
-
-    const targetListItem = focusTextBlock.node.listItem
-    const targetLevel = focusTextBlock.node.level
-    const targetKey = focusTextBlock.node._key
-
-    // Find the target block's index
-    const targetIndex = snapshot.blockIndexMap.get(targetKey)
-
-    if (targetIndex === undefined) {
-      return undefined
-    }
-
-    // Walk backwards from the target block and count consecutive list items
-    // of the same type and level
-    let listIndex = 1 // Start at 1 for the target block itself
-
-    for (let i = targetIndex - 1; i >= 0; i--) {
-      const block = snapshot.context.value[i]
-
-      if (!isTextBlock(snapshot.context, block)) {
-        // Non-text block breaks the sequence
-        break
-      }
-
-      if (block.listItem === undefined || block.level === undefined) {
-        // Non-list item breaks the sequence
-        break
-      }
-
-      if (block.listItem !== targetListItem) {
-        // Different list type breaks the sequence
-        break
-      }
-
-      if (block.level < targetLevel) {
-        // Lower level breaks the sequence
-        break
-      }
-
-      if (block.level === targetLevel) {
-        // Same level - continue counting
-        listIndex++
-      }
-
-      // Higher level items don't affect the count for the target level
-    }
-
-    return listIndex
-  }
-}

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

@@ -1,13 +0,0 @@
-import type {PortableTextBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import {getSelectedValue} from './selector.get-selected-value'
-
-/**
- * @public
- * @deprecated Renamed to `getSelectedValue`.
- */
-export const getSelectedSlice: EditorSelector<Array<PortableTextBlock>> = (
-  snapshot,
-) => {
-  return getSelectedValue(snapshot)
-}