@portabletext/editor 1.50.7 → 1.50.8

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

@@ -3,7 +3,7 @@ import {describe, expect, test} from 'vitest'
 import type {EditorSelector} from '../editor/editor-selector'
 import {defaultKeyGenerator} from '../editor/key-generator'
 import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
-import {getListState, type ListState} from './selector.get-list-state'
+import {getListIndex} from './selector.get-list-state'
 
 function blockObject(_key: string, name: string) {
   return {
@@ -48,16 +48,17 @@ function createSnapshot(value: Array<PortableTextBlock>) {
 
 function getListStates(
   paths: Array<[{_key: string}]>,
-): EditorSelector<Array<ListState | undefined>> {
+): EditorSelector<Array<number | undefined>> {
   return (snapshot) => {
-    return paths.map((path) => getListState({path})(snapshot))
+    return paths.map((path) => getListIndex({path})(snapshot))
   }
 }
-describe(getListState.name, () => {
+
+describe(getListIndex.name, () => {
   test('empty', () => {
     const snapshot = createSnapshot([])
 
-    expect(getListState({path: [{_key: 'k0'}]})(snapshot)).toEqual(undefined)
+    expect(getListIndex({path: [{_key: 'k0'}]})(snapshot)).toEqual(undefined)
   })
 
   test('single list item', () => {
@@ -65,9 +66,7 @@ describe(getListState.name, () => {
       textBlock('k0', {listItem: 'number', level: 1}),
     ])
 
-    expect(getListState({path: [{_key: 'k0'}]})(snapshot)).toEqual({
-      index: 1,
-    })
+    expect(getListIndex({path: [{_key: 'k0'}]})(snapshot)).toEqual(1)
   })
 
   test('single indented list item', () => {
@@ -75,9 +74,7 @@ describe(getListState.name, () => {
       textBlock('k0', {listItem: 'number', level: 2}),
     ])
 
-    expect(getListState({path: [{_key: 'k0'}]})(snapshot)).toEqual({
-      index: 1,
-    })
+    expect(getListIndex({path: [{_key: 'k0'}]})(snapshot)).toEqual(1)
   })
 
   test('two lists broken up by a paragraph', () => {
@@ -97,7 +94,7 @@ describe(getListState.name, () => {
         [{_key: 'k3'}],
         [{_key: 'k4'}],
       ])(snapshot),
-    ).toEqual([{index: 1}, {index: 2}, undefined, {index: 1}, {index: 2}])
+    ).toEqual([1, 2, undefined, 1, 2])
   })
 
   test('two lists broken up by an image', () => {
@@ -117,7 +114,7 @@ describe(getListState.name, () => {
         [{_key: 'k3'}],
         [{_key: 'k4'}],
       ])(snapshot),
-    ).toEqual([{index: 1}, {index: 2}, undefined, {index: 1}, {index: 2}])
+    ).toEqual([1, 2, undefined, 1, 2])
   })
 
   test('numbered lists broken up by a bulleted list', () => {
@@ -129,7 +126,7 @@ describe(getListState.name, () => {
 
     expect(
       getListStates([[{_key: 'k0'}], [{_key: 'k1'}], [{_key: 'k2'}]])(snapshot),
-    ).toEqual([{index: 1}, {index: 1}, {index: 1}])
+    ).toEqual([1, 1, 1])
   })
 
   test('simple indented list', () => {
@@ -147,7 +144,7 @@ describe(getListState.name, () => {
         [{_key: 'k2'}],
         [{_key: 'k3'}],
       ])(snapshot),
-    ).toEqual([{index: 1}, {index: 1}, {index: 2}, {index: 2}])
+    ).toEqual([1, 1, 2, 2])
   })
 
   test('reverse indented list', () => {
@@ -159,7 +156,7 @@ describe(getListState.name, () => {
 
     expect(
       getListStates([[{_key: 'k0'}], [{_key: 'k1'}], [{_key: 'k2'}]])(snapshot),
-    ).toEqual([{index: 1}, {index: 1}, {index: 1}])
+    ).toEqual([1, 1, 1])
   })
 
   test('complex list', () => {
@@ -187,16 +184,6 @@ describe(getListState.name, () => {
         [{_key: 'k7'}],
         [{_key: 'k8'}],
       ])(snapshot),
-    ).toEqual([
-      {index: 1},
-      {index: 1},
-      {index: 1},
-      {index: 1},
-      {index: 2},
-      {index: 1},
-      {index: 1},
-      {index: 2},
-      {index: 3},
-    ])
+    ).toEqual([1, 1, 1, 1, 2, 1, 1, 2, 3])
   })
 })

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

@@ -6,22 +6,14 @@ import {getFocusTextBlock, getPreviousBlock} from './selectors'
 
 /**
  * @beta
- * Represents the List state of a block.
- */
-export type ListState = {
-  index: number
-}
-
-/**
- * @beta
- * Given the `path` of a block, this selector will return the `ListState` of
+ * Given the `path` of a block, this selector will return the "list index" of
  * the block.
  */
-export function getListState({
+export function getListIndex({
   path,
 }: {
   path: BlockPath
-}): EditorSelector<ListState | undefined> {
+}): EditorSelector<number | undefined> {
   return (snapshot) => {
     const selection = {
       anchor: {
@@ -65,39 +57,29 @@ export function getListState({
     })
 
     if (!previousListItem) {
-      return {
-        index: 1,
-      }
+      return 1
     }
 
     if (previousListItem.node.listItem !== focusTextBlock.node.listItem) {
-      return {
-        index: 1,
-      }
+      return 1
     }
 
     if (
       previousListItem.node.level !== undefined &&
       previousListItem.node.level < focusTextBlock.node.level
     ) {
-      return {
-        index: 1,
-      }
+      return 1
     }
 
-    const previousListItemListState = getListState({
+    const previousListItemListState = getListIndex({
       path: previousListItem.path,
     })(snapshot)
 
     if (previousListItemListState === undefined) {
-      return {
-        index: 1,
-      }
+      return 1
     }
 
-    return {
-      index: previousListItemListState.index + 1,
-    }
+    return previousListItemListState + 1
   }
 }