prosemirror-flat-list/src/commands/set-safe-selection.ts

Powerful list support for ProseMirror

import type { ResolvedPos } from 'prosemirror-model'
import {
  type Selection,
  TextSelection,
  type Transaction,
} from 'prosemirror-state'

import { isCollapsedListNode } from '../utils/is-collapsed-list-node'
import { patchCommand } from '../utils/patch-command'
import { setListAttributes } from '../utils/set-list-attributes'

function moveOutOfCollapsed(
  $pos: ResolvedPos,
  minDepth: number,
): Selection | null {
  for (let depth = minDepth; depth <= $pos.depth; depth++) {
    if (isCollapsedListNode($pos.node(depth)) && $pos.index(depth) >= 1) {
      const before = $pos.posAtIndex(1, depth)
      const $before = $pos.doc.resolve(before)
      return TextSelection.near($before, -1)
    }
  }
  return null
}

/**
 * If one of the selection's end points is inside a collapsed node, move the selection outside of it
 *
 * @internal
 */
export function setSafeSelection(tr: Transaction): Transaction {
  const { $from, $to, to } = tr.selection
  const selection =
    moveOutOfCollapsed($from, 0) ||
    moveOutOfCollapsed($to, $from.sharedDepth(to))
  if (selection) {
    tr.setSelection(selection)
  }
  return tr
}

export const withSafeSelection = patchCommand(setSafeSelection)

function getCollapsedPosition($pos: ResolvedPos, minDepth: number) {
  for (let depth = minDepth; depth <= $pos.depth; depth++) {
    if (isCollapsedListNode($pos.node(depth)) && $pos.index(depth) >= 1) {
      return $pos.before(depth)
    }
  }
  return null
}

/**
 * If one of the selection's end points is inside a collapsed node, expand it
 *
 * @internal
 */
export function setVisibleSelection(tr: Transaction): Transaction {
  const { $from, $to, to } = tr.selection
  const pos =
    getCollapsedPosition($from, 0) ??
    getCollapsedPosition($to, $from.sharedDepth(to))
  if (pos != null) {
    tr.doc.resolve(pos)
    setListAttributes(tr, pos, { collapsed: false })
  }
  return tr
}

export const withVisibleSelection = patchCommand(setVisibleSelection)