@portabletext/editor 3.3.2 → 3.3.4

package/src/internal-utils/build-index-maps.test.ts

@@ -1,464 +0,0 @@
-import {compileSchema, defineSchema} from '@portabletext/schema'
-import type {PortableTextBlock} from '@sanity/types'
-import {describe, expect, test} from 'vitest'
-import {defaultKeyGenerator} from '../utils/key-generator'
-import {buildIndexMaps} from './build-index-maps'
-
-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,
-  }
-}
-
-const schema = compileSchema(
-  defineSchema({
-    blockObjects: [{name: 'image'}],
-  }),
-)
-
-describe(buildIndexMaps.name, () => {
-  const blockIndexMap = new Map<string, number>()
-  const listIndexMap = new Map<string, number>()
-
-  test('empty', () => {
-    buildIndexMaps({schema, value: []}, {blockIndexMap, listIndexMap})
-    expect(blockIndexMap).toEqual(new Map())
-    expect(listIndexMap).toEqual(new Map())
-  })
-
-  /**
-   * #
-   */
-  test('single list item', () => {
-    buildIndexMaps(
-      {schema, value: [textBlock('k0', {listItem: 'number', level: 1})]},
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(new Map([['k0', 0]]))
-    expect(listIndexMap).toEqual(new Map([['k0', 1]]))
-  })
-
-  /**
-   *   #
-   */
-  test('single indented list item', () => {
-    buildIndexMaps(
-      {schema, value: [textBlock('k0', {listItem: 'number', level: 2})]},
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(new Map([['k0', 0]]))
-    expect(listIndexMap).toEqual(new Map([['k0', 1]]))
-  })
-
-  /**
-   * #
-   * #
-   *
-   * #
-   * #
-   */
-  test('two lists broken up by a paragraph', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          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}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(
-      new Map([
-        ['k0', 0],
-        ['k1', 1],
-        ['k2', 2],
-        ['k3', 3],
-        ['k4', 4],
-      ]),
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 2],
-        ['k3', 1],
-        ['k4', 2],
-      ]),
-    )
-  })
-
-  /**
-   * #
-   * #
-   * {image}
-   * #
-   * #
-   */
-  test('two lists broken up by an image', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          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}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(
-      new Map([
-        ['k0', 0],
-        ['k1', 1],
-        ['k2', 2],
-        ['k3', 3],
-        ['k4', 4],
-      ]),
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 2],
-        ['k3', 1],
-        ['k4', 2],
-      ]),
-    )
-  })
-
-  /**
-   * #
-   * -
-   * #
-   */
-  test('numbered lists broken up by a bulleted list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'number', level: 1}),
-          textBlock('k1', {listItem: 'bullet', level: 1}),
-          textBlock('k2', {listItem: 'number', level: 1}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(
-      new Map([
-        ['k0', 0],
-        ['k1', 1],
-        ['k2', 2],
-      ]),
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 1],
-        ['k2', 1],
-      ]),
-    )
-  })
-
-  /**
-   * #
-   *   -
-   * #
-   */
-  test('numbered list broken up by an indented bulleted list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'number', level: 1}),
-          textBlock('k1', {listItem: 'bullet', level: 2}),
-          textBlock('k2', {listItem: 'number', level: 1}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 1],
-        ['k2', 2],
-      ]),
-    )
-  })
-
-  /**
-   * #
-   * #
-   * -
-   *   -
-   * #
-   */
-  test('numbered list broken up by a nested bulleted list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'number', level: 1}),
-          textBlock('k1', {listItem: 'number', level: 1}),
-          textBlock('k2', {listItem: 'bullet', level: 1}),
-          textBlock('k3', {listItem: 'bullet', level: 2}),
-          textBlock('k4', {listItem: 'number', level: 1}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 2],
-        ['k2', 1],
-        ['k3', 1],
-        ['k4', 1],
-      ]),
-    )
-  })
-
-  /**
-   * #
-   * #
-   *   -
-   * -
-   *   -
-   * #
-   */
-  test('numbered list broken up by an inverse-indented bulleted list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'number', level: 1}),
-          textBlock('k1', {listItem: 'number', level: 1}),
-          textBlock('k2', {listItem: 'bullet', level: 2}),
-          textBlock('k3', {listItem: 'bullet', level: 1}),
-          textBlock('k4', {listItem: 'bullet', level: 2}),
-          textBlock('k5', {listItem: 'number', level: 1}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 2],
-        ['k2', 1],
-        ['k3', 1],
-        ['k4', 1],
-        ['k5', 1],
-      ]),
-    )
-  })
-
-  /**
-   * #
-   *   #
-   *   #
-   * #
-   */
-  test('simple indented list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'number', level: 1}),
-          textBlock('k1', {listItem: 'number', level: 2}),
-          textBlock('k2', {listItem: 'number', level: 2}),
-          textBlock('k3', {listItem: 'number', level: 1}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(
-      new Map([
-        ['k0', 0],
-        ['k1', 1],
-        ['k2', 2],
-        ['k3', 3],
-      ]),
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 1],
-        ['k2', 2],
-        ['k3', 2],
-      ]),
-    )
-  })
-
-  /**
-   *   #
-   * #
-   *   #
-   */
-  test('reverse indented list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'number', level: 2}),
-          textBlock('k1', {listItem: 'number', level: 1}),
-          textBlock('k2', {listItem: 'number', level: 2}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(
-      new Map([
-        ['k0', 0],
-        ['k1', 1],
-        ['k2', 2],
-      ]),
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 1],
-        ['k2', 1],
-      ]),
-    )
-  })
-
-  /**
-   * #
-   *     #
-   *   #
-   *     #
-   * #
-   *     #
-   *       #
-   *     #
-   * #
-   */
-  test('complex list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          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}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(blockIndexMap).toEqual(
-      new Map([
-        ['k0', 0],
-        ['k1', 1],
-        ['k2', 2],
-        ['k3', 3],
-        ['k4', 4],
-        ['k5', 5],
-        ['k6', 6],
-        ['k7', 7],
-        ['k8', 8],
-      ]),
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 1],
-        ['k2', 1],
-        ['k3', 1],
-        ['k4', 2],
-        ['k5', 1],
-        ['k6', 1],
-        ['k7', 2],
-        ['k8', 3],
-      ]),
-    )
-  })
-
-  /**
-   * -
-   *   #
-   *   #
-   */
-  test('bulleted list with indented numbered list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'bullet', level: 1}),
-          textBlock('k1', {listItem: 'number', level: 2}),
-          textBlock('k2', {listItem: 'number', level: 2}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 1],
-        ['k2', 2],
-      ]),
-    )
-  })
-
-  /**
-   *   #
-   * -
-   *   #
-   */
-  test('indented numbered list broken up by outdented bulleted list', () => {
-    buildIndexMaps(
-      {
-        schema,
-        value: [
-          textBlock('k0', {listItem: 'number', level: 2}),
-          textBlock('k1', {listItem: 'bullet', level: 1}),
-          textBlock('k3', {listItem: 'number', level: 2}),
-        ],
-      },
-      {blockIndexMap, listIndexMap},
-    )
-    expect(listIndexMap).toEqual(
-      new Map([
-        ['k0', 1],
-        ['k1', 1],
-        ['k3', 1],
-      ]),
-    )
-  })
-})

package/src/internal-utils/build-index-maps.ts

@@ -1,131 +0,0 @@
-import {isTextBlock} from '@portabletext/schema'
-import type {EditorContext} from '../editor/editor-snapshot'
-
-// Maps for each list type, keeping track of the current list count for each
-// level.
-const levelIndexMaps = new Map<string, Map<number, number>>()
-
-/**
- * Mutates the maps in place.
- */
-export function buildIndexMaps(
-  context: Pick<EditorContext, 'schema' | 'value'>,
-  {
-    blockIndexMap,
-    listIndexMap,
-  }: {
-    blockIndexMap: Map<string, number>
-    listIndexMap: Map<string, number>
-  },
-): void {
-  blockIndexMap.clear()
-  listIndexMap.clear()
-  levelIndexMaps.clear()
-
-  let previousListItem:
-    | {
-        listItem: string
-        level: number
-      }
-    | undefined
-
-  for (let blockIndex = 0; blockIndex < context.value.length; blockIndex++) {
-    const block = context.value.at(blockIndex)
-
-    if (block === undefined) {
-      continue
-    }
-
-    blockIndexMap.set(block._key, blockIndex)
-
-    // Clear the state if we encounter a non-text block
-    if (!isTextBlock(context, block)) {
-      levelIndexMaps.clear()
-      previousListItem = undefined
-
-      continue
-    }
-
-    // Clear the state if we encounter a non-list text block
-    if (block.listItem === undefined || block.level === undefined) {
-      levelIndexMaps.clear()
-      previousListItem = undefined
-
-      continue
-    }
-
-    // If we encounter a new list item, we set the initial index to 1 for the
-    // list type on that level.
-    if (!previousListItem) {
-      const listIndex = 1
-      const levelIndexMap =
-        levelIndexMaps.get(block.listItem) ?? new Map<number, number>()
-      levelIndexMap.set(block.level, listIndex)
-      levelIndexMaps.set(block.listItem, levelIndexMap)
-
-      listIndexMap.set(block._key, listIndex)
-
-      previousListItem = {
-        listItem: block.listItem,
-        level: block.level,
-      }
-
-      continue
-    }
-
-    // If the previous list item is of the same type but on a lower level, we
-    // need to reset the level index map for that type.
-    if (
-      previousListItem.listItem === block.listItem &&
-      previousListItem.level < block.level
-    ) {
-      const listIndex = 1
-      const levelIndexMap =
-        levelIndexMaps.get(block.listItem) ?? new Map<number, number>()
-      levelIndexMap.set(block.level, listIndex)
-      levelIndexMaps.set(block.listItem, levelIndexMap)
-
-      listIndexMap.set(block._key, listIndex)
-
-      previousListItem = {
-        listItem: block.listItem,
-        level: block.level,
-      }
-
-      continue
-    }
-
-    // Reset other list types at current level and deeper
-    levelIndexMaps.forEach((levelIndexMap, listItem) => {
-      if (listItem === block.listItem) {
-        return
-      }
-
-      // Reset all levels that are >= current level
-      const levelsToDelete: number[] = []
-
-      levelIndexMap.forEach((_, level) => {
-        if (level >= block.level!) {
-          levelsToDelete.push(level)
-        }
-      })
-
-      levelsToDelete.forEach((level) => {
-        levelIndexMap.delete(level)
-      })
-    })
-
-    const levelIndexMap =
-      levelIndexMaps.get(block.listItem) ?? new Map<number, number>()
-    const levelCounter = levelIndexMap.get(block.level) ?? 0
-    levelIndexMap.set(block.level, levelCounter + 1)
-    levelIndexMaps.set(block.listItem, levelIndexMap)
-
-    listIndexMap.set(block._key, levelCounter + 1)
-
-    previousListItem = {
-      listItem: block.listItem,
-      level: block.level,
-    }
-  }
-}

package/src/internal-utils/collapse-selection.ts

@@ -1,36 +0,0 @@
-import type {EditorSelection} from '../types/editor'
-
-export function collapseSelection(
-  selection: EditorSelection,
-  direction: 'start' | 'end',
-): EditorSelection {
-  if (!selection) {
-    return selection
-  }
-
-  if (direction === 'start') {
-    return selection.backward
-      ? {
-          anchor: selection.focus,
-          focus: selection.focus,
-          backward: false,
-        }
-      : {
-          anchor: selection.anchor,
-          focus: selection.anchor,
-          backward: false,
-        }
-  }
-
-  return selection.backward
-    ? {
-        anchor: selection.anchor,
-        focus: selection.anchor,
-        backward: false,
-      }
-    : {
-        anchor: selection.focus,
-        focus: selection.focus,
-        backward: false,
-      }
-}

package/src/internal-utils/compound-client-rect.ts

@@ -1,28 +0,0 @@
-export function getCompoundClientRect(nodes: Array<Node>): DOMRect {
-  if (nodes.length === 0) {
-    return new DOMRect(0, 0, 0, 0)
-  }
-
-  const elements = nodes.filter((node) => node instanceof Element)
-
-  const firstRect = elements.at(0)?.getBoundingClientRect()
-
-  if (!firstRect) {
-    return new DOMRect(0, 0, 0, 0)
-  }
-
-  let left = firstRect.left
-  let top = firstRect.top
-  let right = firstRect.right
-  let bottom = firstRect.bottom
-
-  for (let i = 1; i < elements.length; i++) {
-    const rect = elements[i].getBoundingClientRect()
-    left = Math.min(left, rect.left)
-    top = Math.min(top, rect.top)
-    right = Math.max(right, rect.right)
-    bottom = Math.max(bottom, rect.bottom)
-  }
-
-  return new DOMRect(left, top, right - left, bottom - top)
-}

package/src/internal-utils/create-placeholder-block.ts

@@ -1,21 +0,0 @@
-import type {PortableTextSpan} from '@sanity/types'
-import type {EditorContext} from '../editor/editor-snapshot'
-
-export function createPlaceholderBlock(
-  context: Pick<EditorContext, 'keyGenerator' | 'schema'>,
-) {
-  return {
-    _type: context.schema.block.name,
-    _key: context.keyGenerator(),
-    style: context.schema.styles[0].name ?? 'normal',
-    markDefs: [],
-    children: [
-      {
-        _type: context.schema.span.name,
-        _key: context.keyGenerator(),
-        text: '',
-        marks: [],
-      } as PortableTextSpan,
-    ],
-  }
-}

package/src/internal-utils/create-test-snapshot.ts

@@ -1,28 +0,0 @@
-import {compileSchema, defineSchema} from '@portabletext/schema'
-import {createTestKeyGenerator} from '@portabletext/test'
-import type {EditorSnapshot} from '../editor/editor-snapshot'
-
-export function createTestSnapshot(snapshot: {
-  context?: Partial<EditorSnapshot['context']>
-  decoratorState?: Partial<EditorSnapshot['decoratorState']>
-}): EditorSnapshot {
-  const context = {
-    converters: snapshot.context?.converters ?? [],
-    schema: snapshot.context?.schema ?? compileSchema(defineSchema({})),
-    keyGenerator: snapshot.context?.keyGenerator ?? createTestKeyGenerator(),
-    readOnly: snapshot.context?.readOnly ?? false,
-    value: snapshot.context?.value ?? [],
-    selection: snapshot.context?.selection ?? null,
-  }
-  const blockIndexMap = new Map<string, number>()
-
-  snapshot.context?.value?.forEach((block, index) => {
-    blockIndexMap.set(block._key, index)
-  })
-
-  return {
-    blockIndexMap,
-    context,
-    decoratorState: snapshot?.decoratorState ?? {},
-  }
-}