@prosekit/core 0.8.7 → 0.10.0

package/src/extensions/command.ts

@@ -1,52 +1,18 @@
-import {
-  addMark,
-  type AddMarkOptions,
-} from '../commands/add-mark'
-import {
-  insertDefaultBlock,
-  type InsertDefaultBlockOptions,
-} from '../commands/insert-default-block'
-import {
-  insertNode,
-  type InsertNodeOptions,
-} from '../commands/insert-node'
-import {
-  insertText,
-  type InsertTextOptions,
-} from '../commands/insert-text'
-import {
-  removeMark,
-  type RemoveMarkOptions,
-} from '../commands/remove-mark'
-import {
-  removeNode,
-  type RemoveNodeOptions,
-} from '../commands/remove-node'
+import { addMark, type AddMarkOptions } from '../commands/add-mark'
+import { insertDefaultBlock, type InsertDefaultBlockOptions } from '../commands/insert-default-block'
+import { insertNode, type InsertNodeOptions } from '../commands/insert-node'
+import { insertText, type InsertTextOptions } from '../commands/insert-text'
+import { removeMark, type RemoveMarkOptions } from '../commands/remove-mark'
+import { removeNode, type RemoveNodeOptions } from '../commands/remove-node'
 import { selectAll } from '../commands/select-all'
-import {
-  setBlockType,
-  type SetBlockTypeOptions,
-} from '../commands/set-block-type'
-import {
-  setNodeAttrs,
-  type SetNodeAttrsOptions,
-} from '../commands/set-node-attrs'
-import {
-  toggleWrap,
-  type ToggleWrapOptions,
-} from '../commands/toggle-wrap'
-import {
-  unsetBlockType,
-  type UnsetBlockTypeOptions,
-} from '../commands/unset-block-type'
-import {
-  unsetMark,
-  type UnsetMarkOptions,
-} from '../commands/unset-mark'
-import {
-  wrap,
-  type WrapOptions,
-} from '../commands/wrap'
+import { selectBlock } from '../commands/select-block'
+import { setBlockType, type SetBlockTypeOptions } from '../commands/set-block-type'
+import { setNodeAttrs, type SetNodeAttrsOptions } from '../commands/set-node-attrs'
+import { setNodeAttrsBetween, type SetNodeAttrsBetweenOptions } from '../commands/set-node-attrs-between'
+import { toggleWrap, type ToggleWrapOptions } from '../commands/toggle-wrap'
+import { unsetBlockType, type UnsetBlockTypeOptions } from '../commands/unset-block-type'
+import { unsetMark, type UnsetMarkOptions } from '../commands/unset-mark'
+import { wrap, type WrapOptions } from '../commands/wrap'
 import { commandFacet } from '../facets/command'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { Extension } from '../types/extension'
@@ -76,8 +42,10 @@ export type BaseCommandsExtension = Extension<{
     toggleWrap: [options: ToggleWrapOptions]
     setBlockType: [options: SetBlockTypeOptions]
     setNodeAttrs: [options: SetNodeAttrsOptions]
+    setNodeAttrsBetween: [options: SetNodeAttrsBetweenOptions]
     insertDefaultBlock: [options?: InsertDefaultBlockOptions]
     selectAll: []
+    selectBlock: []
     addMark: [options: AddMarkOptions]
     removeMark: [options: RemoveMarkOptions]
     unsetBlockType: [options?: UnsetBlockTypeOptions]
@@ -106,10 +74,14 @@ export function defineBaseCommands(): BaseCommandsExtension {
 
     setNodeAttrs,
 
+    setNodeAttrsBetween,
+
     insertDefaultBlock,
 
     selectAll,
 
+    selectBlock,
+
     addMark,
 
     removeMark,

package/src/extensions/default-state.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { createEditor } from '../editor/editor'
 import { defineTestExtension } from '../testing'
@@ -27,10 +23,6 @@ describe('defineDefaultState', () => {
       return editor.state.doc.toString()
     }
 
-    expect(run({ defaultDoc: docJSON })).toContain('docJSON')
-    expect(run({ defaultHTML: docHTMLString })).toContain('docHTMLString')
-    expect(run({ defaultHTML: docHTMLElement })).toContain('docHTMLElement')
-
     expect(run({ defaultContent: docJSON })).toContain('docJSON')
     expect(run({ defaultContent: docHTMLString })).toContain('docHTMLString')
     expect(run({ defaultContent: docHTMLElement })).toContain('docHTMLElement')

package/src/extensions/default-state.ts

@@ -1,15 +1,9 @@
-import {
-  Selection,
-  type EditorStateConfig,
-} from '@prosekit/pm/state'
+import { Selection, type EditorStateConfig } from '@prosekit/pm/state'
 
 import { defineFacetPayload } from '../facets/facet-extension'
 import { stateFacet } from '../facets/state'
 import type { PlainExtension } from '../types/extension'
-import type {
-  NodeJSON,
-  SelectionJSON,
-} from '../types/model'
+import type { NodeJSON, SelectionJSON } from '../types/model'
 import { getEditorContentJSON } from '../utils/editor-content'
 
 /**
@@ -18,25 +12,9 @@ import { getEditorContentJSON } from '../utils/editor-content'
 export interface DefaultStateOptions {
   /**
    * The starting document to use when creating the editor. It can be a
-   * ProseMirror node JSON object, a HTML string, or a HTML element instance.
+   * ProseMirror node JSON object, an HTML string, or a DOM element instance.
    */
-  defaultContent?: NodeJSON | string | HTMLElement
-
-  /**
-   * A JSON object representing the starting document to use when creating the
-   * editor.
-   *
-   * @deprecated Use `defaultContent` instead.
-   */
-  defaultDoc?: NodeJSON
-
-  /**
-   * A HTML element or a HTML string representing the starting document to use
-   * when creating the editor.
-   *
-   * @deprecated Use `defaultContent` instead.
-   */
-  defaultHTML?: string | HTMLElement
+  defaultContent?: NodeJSON | string | Element
 
   /**
    * A JSON object representing the starting selection to use when creating the
@@ -55,16 +33,12 @@ export interface DefaultStateOptions {
 export function defineDefaultState({
   defaultSelection,
   defaultContent,
-  defaultDoc,
-  defaultHTML,
 }: DefaultStateOptions): PlainExtension {
-  const defaultDocContent = defaultContent || defaultDoc || defaultHTML
-
   return defineFacetPayload(stateFacet, [
     ({ schema }) => {
       const config: EditorStateConfig = {}
-      if (defaultDocContent) {
-        const json = getEditorContentJSON(schema, defaultDocContent)
+      if (defaultContent) {
+        const json = getEditorContentJSON(schema, defaultContent)
         config.doc = schema.nodeFromJSON(json)
         if (defaultSelection) {
           config.selection = Selection.fromJSON(config.doc, defaultSelection)

package/src/extensions/events/dom-event.spec.ts

@@ -1,9 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-  vi,
-} from 'vitest'
+import { describe, expect, it, vi } from 'vitest'
 
 import { createEditor } from '../../editor/editor'
 import { defineTestExtension } from '../../testing'

package/src/extensions/events/dom-event.ts

@@ -1,25 +1,13 @@
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-} from '@prosekit/pm/state'
-import type {
-  DOMEventMap,
-  EditorView,
-} from '@prosekit/pm/view'
+import { PluginKey, ProseMirrorPlugin } from '@prosekit/pm/state'
+import type { DOMEventMap, EditorView } from '@prosekit/pm/view'
 
-import {
-  defineFacet,
-  type Facet,
-} from '../../facets/facet'
+import { defineFacet, type Facet } from '../../facets/facet'
 import { defineFacetPayload } from '../../facets/facet-extension'
 import type { PlainExtension } from '../../types/extension'
 import type { Setter } from '../../types/setter'
 import { groupEntries } from '../../utils/array-grouping'
 import { combineEventHandlers } from '../../utils/combine-event-handlers'
-import {
-  pluginFacet,
-  type PluginPayload,
-} from '../plugin'
+import { pluginFacet, type PluginPayload } from '../plugin'
 
 /**
  * A function to handle the events fired on the editable DOM element. Returns
@@ -85,10 +73,7 @@ const domEventFacet: Facet<DOMEventPayload, PluginPayload> = defineFacet(
             hasNewEvent = true
             const [setHandlers, combinedHandler] = combineEventHandlers<DOMEventHandler>()
             setHandlersMap[event] = setHandlers
-            const e: DOMEventHandler = (view, eventObject) => {
-              return combinedHandler(view, eventObject)
-            }
-            combinedHandlerMap[event] = e
+            combinedHandlerMap[event] = combinedHandler
           }
         }
 

package/src/extensions/events/editor-event.ts

@@ -1,26 +1,14 @@
-import type {
-  Node,
-  Slice,
-} from '@prosekit/pm/model'
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-} from '@prosekit/pm/state'
+import type { ObjectEntries } from '@ocavue/utils'
+import type { Node, Slice } from '@prosekit/pm/model'
+import { PluginKey, ProseMirrorPlugin } from '@prosekit/pm/state'
 import type { EditorView } from '@prosekit/pm/view'
 
-import {
-  defineFacet,
-  type Facet,
-} from '../../facets/facet'
+import { defineFacet, type Facet } from '../../facets/facet'
 import { defineFacetPayload } from '../../facets/facet-extension'
 import type { PlainExtension } from '../../types/extension'
-import type { ObjectEntries } from '../../types/object-entries'
 import { groupEntries } from '../../utils/array-grouping'
 import { combineEventHandlers } from '../../utils/combine-event-handlers'
-import {
-  pluginFacet,
-  type PluginPayload,
-} from '../plugin'
+import { pluginFacet, type PluginPayload } from '../plugin'
 
 export type KeyDownHandler = (
   view: EditorView,

package/src/extensions/events/focus.spec.ts

@@ -1,9 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-  vi,
-} from 'vitest'
+import { describe, expect, it, vi } from 'vitest'
 
 import { createEditor } from '../../editor/editor'
 import { union } from '../../editor/union'

package/src/extensions/events/plugin-view.ts

@@ -1,17 +1,10 @@
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-  type EditorState,
-} from '@prosekit/pm/state'
+import { PluginKey, ProseMirrorPlugin, type EditorState } from '@prosekit/pm/state'
 import type { EditorView } from '@prosekit/pm/view'
 
 import { defineFacet } from '../../facets/facet'
 import { defineFacetPayload } from '../../facets/facet-extension'
 import type { PlainExtension } from '../../types/extension'
-import {
-  pluginFacet,
-  type PluginPayload,
-} from '../plugin'
+import { pluginFacet, type PluginPayload } from '../plugin'
 
 /**
  * A function that is called when the editor view is mounted.

package/src/extensions/history.ts

@@ -1,23 +1,16 @@
-import {
-  history,
-  redo,
-  undo,
-} from '@prosekit/pm/history'
+import { history, redo, undo } from '@prosekit/pm/history'
 
 import { union } from '../editor/union'
 import type { Extension } from '../types/extension'
 import { isApple } from '../utils/env'
 
 import { defineCommands } from './command'
-import {
-  defineKeymap,
-  type Keymap,
-} from './keymap'
+import { defineKeymap, type Keymap } from './keymap'
 import { definePlugin } from './plugin'
 
 const keymap: Keymap = {
   'Mod-z': undo,
-  'Shift-Mod-z': redo,
+  'Mod-Z': redo,
 }
 
 if (!isApple) {

package/src/extensions/keymap-base.spec.ts

@@ -0,0 +1,89 @@
+import { describe, expect, it } from 'vitest'
+import { keyboard } from 'vitest-browser-commands/playwright'
+
+import { union } from '../editor/union'
+import type { TestEditor } from '../test'
+import { defineDoc, defineParagraph, defineText, setupTestFromExtension } from '../testing'
+import type { SelectionJSON } from '../types/model'
+
+import { defineBaseKeymap } from './keymap-base'
+
+describe('Mod-a', () => {
+  it('can select the block for the first Mod-a press', async () => {
+    const { editor, n } = setupTestFromExtension(union(
+      defineDoc(),
+      defineText(),
+      defineParagraph(),
+      defineBaseKeymap(),
+    ))
+
+    editor.set(n.doc(n.paragraph('Fo<a>o<b>'), n.paragraph('Bar')))
+    await keyboard.press('ControlOrMeta+a')
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"text: <paragraph("Foo")>"`)
+    await keyboard.press('ControlOrMeta+a')
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"all: <paragraph("Foo"), paragraph("Bar")>"`)
+  })
+
+  it('can select the entire document if the current textblock is already selected', async () => {
+    const { editor, n } = setupTestFromExtension(union(
+      defineDoc(),
+      defineText(),
+      defineParagraph(),
+      defineBaseKeymap(),
+    ))
+
+    editor.set(n.doc(n.paragraph('<a>Foo<b>'), n.paragraph('Bar')))
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"text: <paragraph("Foo")>"`)
+    await keyboard.press('ControlOrMeta+a')
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"all: <paragraph("Foo"), paragraph("Bar")>"`)
+  })
+
+  it('can select the entire document if multiple textblocks are already selected', async () => {
+    const { editor, n } = setupTestFromExtension(union(
+      defineDoc(),
+      defineText(),
+      defineParagraph(),
+      defineBaseKeymap(),
+    ))
+
+    editor.set(n.doc(n.paragraph('<a>Foo'), n.paragraph('Bar<b>'), n.paragraph('Baz')))
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"text: <paragraph("Foo"), paragraph("Bar")>"`)
+    await keyboard.press('ControlOrMeta+a')
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"all: <paragraph("Foo"), paragraph("Bar"), paragraph("Baz")>"`)
+  })
+
+  it('can select the entire document if the current textblock is empty', async () => {
+    const { editor, n } = setupTestFromExtension(union(
+      defineDoc(),
+      defineText(),
+      defineParagraph(),
+      defineBaseKeymap(),
+    ))
+
+    editor.set(n.doc(n.paragraph('Foo'), n.paragraph('<a>'), n.paragraph('Bar')))
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"text: <>"`)
+    await keyboard.press('ControlOrMeta+a')
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"all: <paragraph("Foo"), paragraph, paragraph("Bar")>"`)
+  })
+
+  it('can select the entire document directly if `preferBlockSelection` is false', async () => {
+    const { editor, n } = setupTestFromExtension(union(
+      defineDoc(),
+      defineText(),
+      defineParagraph(),
+      defineBaseKeymap({ preferBlockSelection: false }),
+    ))
+
+    editor.set(n.doc(n.paragraph('<a>Foo<b>'), n.paragraph('Bar')))
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"text: <paragraph("Foo")>"`)
+    await keyboard.press('ControlOrMeta+a')
+    expect(inspectSelection(editor)).toMatchInlineSnapshot(`"all: <paragraph("Foo"), paragraph("Bar")>"`)
+  })
+})
+
+function inspectSelection(editor: TestEditor) {
+  const selection = editor.state.selection
+  const text = selection.content().content.toString()
+  const json = selection.toJSON() as SelectionJSON
+  return `${json.type}: ${text}`
+}

package/src/extensions/keymap-base.ts

@@ -6,15 +6,17 @@ import {
   joinTextblockBackward,
   liftEmptyBlock,
   newlineInCode,
+  selectAll,
   selectNodeBackward,
 } from '@prosekit/pm/commands'
 import { splitSplittableBlock } from 'prosemirror-splittable'
 
+import { selectBlockCommand } from '../commands/select-block'
 import { withPriority } from '../editor/with-priority'
 import type { PlainExtension } from '../types/extension'
 import { Priority } from '../types/priority'
 
-import { defineKeymap } from './keymap'
+import { defineKeymap, type Keymap } from './keymap'
 
 // Replace `splitBlock` with `splitSplittableBlock`
 const customEnter = chainCommands(
@@ -31,30 +33,49 @@ const customBackspace = chainCommands(
   selectNodeBackward,
 )
 
-const customBaseKeymap = {
-  ...baseKeymap,
-  Enter: customEnter,
-  Backspace: customBackspace,
-}
-
 /**
  * @internal
  */
 export type BaseKeymapExtension = PlainExtension
 
 /**
- * Defines some basic key bindings.
- *
  * @public
  */
-export function defineBaseKeymap(options?: {
+export interface BaseKeymapOptions {
   /**
    * The priority of the keymap.
    *
    * @default Priority.low
    */
   priority?: Priority
-}): BaseKeymapExtension {
-  const priority = options?.priority ?? Priority.low
-  return withPriority(defineKeymap(customBaseKeymap), priority)
+
+  /**
+   * If `true`, the first `Mod-a` press selects the current block that the
+   * cursor is in, and a second press selects the entire document.
+   *
+   * If `false`, `Mod-a` immediately selects the entire document.
+   *
+   * @default true
+   */
+  preferBlockSelection?: boolean
+}
+
+/**
+ * Defines some basic key bindings.
+ *
+ * @param options
+ *
+ * @public
+ */
+export function defineBaseKeymap({
+  priority = Priority.low,
+  preferBlockSelection = true,
+}: BaseKeymapOptions = {}): BaseKeymapExtension {
+  const keymap: Keymap = {
+    ...baseKeymap,
+    'Mod-a': preferBlockSelection ? chainCommands(selectBlockCommand, selectAll) : selectAll,
+    'Enter': customEnter,
+    'Backspace': customBackspace,
+  }
+  return withPriority(defineKeymap(keymap), priority)
 }

package/src/extensions/keymap.spec.ts

@@ -1,27 +1,13 @@
 import type { Command } from '@prosekit/pm/state'
-import {
-  describe,
-  expect,
-  it,
-  vi,
-} from 'vitest'
+import { describe, expect, it, vi } from 'vitest'
 import { keyboard } from 'vitest-browser-commands/playwright'
 
 import { union } from '../editor/union'
 import { withPriority } from '../editor/with-priority'
-import {
-  defineDoc,
-  defineParagraph,
-  defineText,
-  setupTest,
-  setupTestFromExtension,
-} from '../testing'
+import { defineDoc, defineParagraph, defineText, setupTest, setupTestFromExtension } from '../testing'
 import { Priority } from '../types/priority'
 
-import {
-  defineKeymap,
-  type Keymap,
-} from './keymap'
+import { defineKeymap, type Keymap } from './keymap'
 
 describe('keymap', () => {
   it('can register and unregister keymap', () => {
@@ -159,9 +145,13 @@ describe('keymap', () => {
       // Do not match
       'ctrl-c',
     ]
-    const keymap: Keymap = Object.fromEntries(keybindings.map(binding => [binding, record(binding)]))
 
-    editor.use(defineKeymap(keymap))
+    for (const key of keybindings) {
+      const command: Command = record(key)
+      const keymap: Keymap = { [key]: command }
+      const extension = defineKeymap(keymap)
+      editor.use(extension)
+    }
 
     called.length = 0
     await keyboard.down('Control')
@@ -170,8 +160,8 @@ describe('keymap', () => {
     await keyboard.up('Control')
     expect(called).toMatchInlineSnapshot(`
       [
-        "ctrl-b",
         "CTRL-b",
+        "ctrl-b",
       ]
     `)
 
@@ -184,10 +174,10 @@ describe('keymap', () => {
     await keyboard.up('Control')
     expect(called).toMatchInlineSnapshot(`
       [
-        "c-s-B",
-        "c-B",
         "Ctrl-B",
+        "c-s-B",
         "ctrl-shift-b",
+        "c-B",
       ]
     `)
   })

package/src/extensions/keymap.ts

@@ -1,26 +1,12 @@
-import { chainCommands } from '@prosekit/pm/commands'
 import { keydownHandler } from '@prosekit/pm/keymap'
-import {
-  Plugin,
-  PluginKey,
-  type Command,
-} from '@prosekit/pm/state'
+import { Plugin, PluginKey, type Command } from '@prosekit/pm/state'
 import type { EditorView } from '@prosekit/pm/view'
-import mapValues from 'just-map-values'
 
-import {
-  defineFacet,
-  type Facet,
-} from '../facets/facet'
+import { defineFacet, type Facet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { PlainExtension } from '../types/extension'
-import { toReversed } from '../utils/array'
-import { isApple } from '../utils/env'
 
-import {
-  pluginFacet,
-  type PluginPayload,
-} from './plugin'
+import { pluginFacet, type PluginPayload } from './plugin'
 
 /**
  * A set of keybindings. Please read the
@@ -55,27 +41,29 @@ export const keymapFacet: Facet<KeymapPayload, PluginPayload> = defineFacet<
   PluginPayload
 >({
   reduce: () => {
-    type Handler = (view: EditorView, event: KeyboardEvent) => boolean
+    type KeydownHandler = (view: EditorView, event: KeyboardEvent) => boolean
 
-    let handler: Handler | undefined
+    // An array of keymap handlers, ordered from the highest priority to the lowest.
+    let subHandlers: KeydownHandler[] = []
 
-    const handlerWrapper: Handler = (view, event) => {
-      if (handler) return handler(view, event)
+    // A root handler that combines all the sub handlers.
+    const rootHandler: KeydownHandler = (view, event) => {
+      for (const handler of subHandlers) {
+        if (handler(view, event)) return true
+      }
       return false
     }
 
     const plugin = new Plugin({
       key: keymapPluginKey,
-      props: { handleKeyDown: handlerWrapper },
+      props: { handleKeyDown: rootHandler },
     })
 
     return (keymaps: Keymap[]) => {
-      handler = keydownHandler(
-        mergeKeymaps(
-          // The keymap at the end have a higher priority.
-          toReversed(keymaps),
-        ),
-      )
+      // The keymap at the end has a higher priority, so we need to reverse the
+      // order here.
+      subHandlers = keymaps.map(keydownHandler).reverse()
+
       return plugin
     }
   },
@@ -83,45 +71,4 @@ export const keymapFacet: Facet<KeymapPayload, PluginPayload> = defineFacet<
   singleton: true,
 })
 
-function mergeKeymaps(keymaps: Keymap[]): Keymap {
-  const bindings: Record<string, Command[]> = {}
-
-  for (const keymap of keymaps) {
-    for (const [key, command] of Object.entries(keymap)) {
-      const normalizedKey = normalizeKeyName(key)
-      const commands = bindings[normalizedKey] ||= []
-      commands.push(command)
-    }
-  }
-
-  return mapValues(bindings, mergeCommands)
-}
-
-function mergeCommands(commands: Command[]): Command {
-  return chainCommands(...commands)
-}
-
-// Copied from https://github.com/ProseMirror/prosemirror-keymap/blob/1.2.3/src/keymap.ts#L8
-function normalizeKeyName(name: string) {
-  let parts = name.split(/-(?!$)/), result = parts[parts.length - 1]
-  if (result == 'Space') result = ' '
-  let alt, ctrl, shift, meta
-  for (let i = 0; i < parts.length - 1; i++) {
-    let mod = parts[i]
-    if (/^(cmd|meta|m)$/i.test(mod)) meta = true
-    else if (/^a(lt)?$/i.test(mod)) alt = true
-    else if (/^(c|ctrl|control)$/i.test(mod)) ctrl = true
-    else if (/^s(hift)?$/i.test(mod)) shift = true
-    else if (/^mod$/i.test(mod)) {
-      if (isApple) meta = true
-      else ctrl = true
-    } else throw new Error('Unrecognized modifier name: ' + mod)
-  }
-  if (alt) result = 'Alt-' + result
-  if (ctrl) result = 'Ctrl-' + result
-  if (meta) result = 'Meta-' + result
-  if (shift) result = 'Shift-' + result
-  return result
-}
-
 const keymapPluginKey = new PluginKey('prosekit-keymap')