@prosekit/core 0.8.6 → 0.9.0

package/src/extensions/keymap-base.ts

@@ -6,15 +6,20 @@ 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 +36,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

@@ -5,10 +5,17 @@ import {
   it,
   vi,
 } from 'vitest'
+import { keyboard } from 'vitest-browser-commands/playwright'
 
 import { union } from '../editor/union'
 import { withPriority } from '../editor/with-priority'
-import { setupTest } from '../testing'
+import {
+  defineDoc,
+  defineParagraph,
+  defineText,
+  setupTest,
+  setupTestFromExtension,
+} from '../testing'
 import { Priority } from '../types/priority'
 
 import {
@@ -122,4 +129,70 @@ describe('keymap', () => {
     // Highest priority should be called first
     expect(callOrder).toEqual(['highest', 'default', 'lowest'])
   })
+
+  it('can merge keybindings with different variants', async () => {
+    const called: string[] = []
+    const { editor } = setupTestFromExtension(union(
+      defineDoc(),
+      defineText(),
+      defineParagraph(),
+    ))
+
+    const record = (label: string): Command => {
+      return () => {
+        called.push(label)
+        return false
+      }
+    }
+
+    const keybindings = [
+      // Match Ctrl-b
+      'ctrl-b',
+      'CTRL-b',
+
+      // Match Ctrl-Shift-b
+      'c-B',
+      'ctrl-shift-b',
+      'c-s-B',
+      'Ctrl-B',
+
+      // Do not match
+      'ctrl-c',
+    ]
+
+    for (const key of keybindings) {
+      let command: Command = record(key)
+      let keymap: Keymap = { [key]: command }
+      let extension = defineKeymap(keymap)
+      editor.use(extension)
+    }
+
+    called.length = 0
+    await keyboard.down('Control')
+    await keyboard.down('b')
+    await keyboard.up('b')
+    await keyboard.up('Control')
+    expect(called).toMatchInlineSnapshot(`
+      [
+        "CTRL-b",
+        "ctrl-b",
+      ]
+    `)
+
+    called.length = 0
+    await keyboard.down('Control')
+    await keyboard.down('Shift')
+    await keyboard.down('B')
+    await keyboard.up('B')
+    await keyboard.up('Shift')
+    await keyboard.up('Control')
+    expect(called).toMatchInlineSnapshot(`
+      [
+        "Ctrl-B",
+        "c-s-B",
+        "ctrl-shift-b",
+        "c-B",
+      ]
+    `)
+  })
 })

package/src/extensions/keymap.ts

@@ -1,4 +1,3 @@
-import { chainCommands } from '@prosekit/pm/commands'
 import { keydownHandler } from '@prosekit/pm/keymap'
 import {
   Plugin,
@@ -6,7 +5,6 @@ import {
   type Command,
 } from '@prosekit/pm/state'
 import type { EditorView } from '@prosekit/pm/view'
-import mapValues from 'just-map-values'
 
 import {
   defineFacet,
@@ -14,7 +12,6 @@ import {
 } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { PlainExtension } from '../types/extension'
-import { toReversed } from '../utils/array'
 
 import {
   pluginFacet,
@@ -22,6 +19,9 @@ import {
 } from './plugin'
 
 /**
+ * A set of keybindings. Please read the
+ * [documentation](https://prosemirror.net/docs/ref/#keymap) for more details.
+ *
  * @public
  */
 export interface Keymap {
@@ -29,6 +29,9 @@ export interface Keymap {
 }
 
 /**
+ * Adds a set of keybindings to the editor. Please read the
+ * [documentation](https://prosemirror.net/docs/ref/#keymap) for more details.
+ *
  * @public
  */
 export function defineKeymap(keymap: Keymap): PlainExtension {
@@ -48,27 +51,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
     }
   },
@@ -76,21 +81,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 commands = bindings[key] || (bindings[key] = [])
-      commands.push(command)
-    }
-  }
-
-  return mapValues(bindings, mergeCommands)
-}
-
-function mergeCommands(commands: Command[]): Command {
-  return chainCommands(...commands)
-}
-
 const keymapPluginKey = new PluginKey('prosekit-keymap')

package/src/extensions/mark-spec.ts

@@ -1,9 +1,9 @@
+import { mapGroupBy } from '@ocavue/utils'
 import type {
+  AttributeSpec,
   MarkSpec,
-  ParseRule,
   SchemaSpec,
 } from '@prosekit/pm/model'
-import clone from 'just-clone'
 import OrderedMap from 'orderedmap'
 
 import { defineFacet } from '../facets/facet'
@@ -14,12 +14,11 @@ import type {
   AttrSpec,
 } from '../types/attrs'
 import type { Extension } from '../types/extension'
-import { groupBy } from '../utils/array-grouping'
 import { assert } from '../utils/assert'
 import { mergeSpecs } from '../utils/merge-specs'
 import {
   wrapOutputSpecAttrs,
-  wrapTagParseRuleAttrs,
+  wrapParseRuleAttrs,
 } from '../utils/output-spec'
 import { isNotNullish } from '../utils/type-assertion'
 
@@ -76,7 +75,24 @@ export interface MarkAttrOptions<
 }
 
 /**
+ * Defines a mark type into the editor schema.
+ *
  * @public
+ *
+ * @example
+ *
+ * ```ts
+ * const extension = defineMarkSpec({
+ *   name: 'bold',
+ *   parseDOM: [
+ *     { tag: 'strong' },
+ *     { tag: 'b' },
+ *   ],
+ *   toDOM() {
+ *     return ['strong', 0]
+ *   },
+ * })
+ * ```
  */
 export function defineMarkSpec<
   Mark extends string,
@@ -133,35 +149,32 @@ const markSpecFacet = defineFacet<MarkSpecPayload, SchemaSpec>({
       }
     }
 
-    const groupedAttrs = groupBy(attrPayloads, (payload) => payload.type)
+    const groupedAttrs = mapGroupBy(attrPayloads, (payload) => payload.type)
 
-    for (const [type, attrs] of Object.entries(groupedAttrs)) {
+    for (const [type, attrs] of groupedAttrs.entries()) {
       if (!attrs) continue
 
-      const maybeSpec = specs.get(type)
-      assert(maybeSpec, `Mark type ${type} must be defined`)
-      const spec = clone(maybeSpec)
+      const oldSpec = specs.get(type)
+      assert(oldSpec, `Mark type ${type} must be defined`)
 
-      if (!spec.attrs) {
-        spec.attrs = {}
-      }
+      const newSpec = { ...oldSpec, attrs: { ...oldSpec.attrs } } satisfies MarkSpec
 
       for (const attr of attrs) {
-        spec.attrs[attr.attr] = {
+        newSpec.attrs[attr.attr] = {
           default: attr.default as unknown,
           validate: attr.validate,
-        }
+        } satisfies AttributeSpec
       }
 
-      if (spec.toDOM) {
-        spec.toDOM = wrapOutputSpecAttrs(spec.toDOM, attrs)
+      if (oldSpec.toDOM) {
+        newSpec.toDOM = wrapOutputSpecAttrs(oldSpec.toDOM, attrs)
       }
 
-      if (spec.parseDOM) {
-        spec.parseDOM = spec.parseDOM.map((rule) => wrapParseRuleAttrs(rule, attrs))
+      if (oldSpec.parseDOM) {
+        newSpec.parseDOM = oldSpec.parseDOM.map((rule) => wrapParseRuleAttrs(rule, attrs))
       }
 
-      specs = specs.update(type, spec)
+      specs = specs.update(type, newSpec)
     }
 
     return { marks: specs, nodes: {} }
@@ -169,13 +182,3 @@ const markSpecFacet = defineFacet<MarkSpecPayload, SchemaSpec>({
   parent: schemaSpecFacet,
   singleton: true,
 })
-
-function wrapParseRuleAttrs(
-  rule: ParseRule,
-  attrs: MarkAttrOptions[],
-): ParseRule {
-  if (rule.tag) {
-    return wrapTagParseRuleAttrs(rule, attrs)
-  }
-  return rule
-}

package/src/extensions/node-spec.ts

@@ -1,9 +1,9 @@
+import { mapGroupBy } from '@ocavue/utils'
 import type {
   AttributeSpec,
   NodeSpec,
   SchemaSpec,
 } from '@prosekit/pm/model'
-import clone from 'just-clone'
 import OrderedMap from 'orderedmap'
 
 import { defineFacet } from '../facets/facet'
@@ -14,7 +14,6 @@ import type {
   AttrSpec,
 } from '../types/attrs'
 import type { Extension } from '../types/extension'
-import { groupBy } from '../utils/array-grouping'
 import { assert } from '../utils/assert'
 import { mergeSpecs } from '../utils/merge-specs'
 import {
@@ -93,9 +92,23 @@ export interface NodeAttrOptions<
 }
 
 /**
- * Defines a node type.
+ * Defines a node type into the editor schema.
  *
  * @public
+ *
+ * @example
+ *
+ * ```ts
+ * const extension = defineNodeSpec({
+ *   name: 'fancyParagraph',
+ *   content: 'inline*',
+ *   group: 'block',
+ *   parseDOM: [{ tag: 'p.fancy' }],
+ *   toDOM() {
+ *     return ['p', { 'class': 'fancy' }, 0]
+ *   },
+ * })
+ * ```
  */
 export function defineNodeSpec<
   Node extends string,
@@ -159,37 +172,33 @@ const nodeSpecFacet = defineFacet<NodeSpecPayload, SchemaSpec>({
       }
     }
 
-    const groupedAttrs = groupBy(attrPayloads, (payload) => payload.type)
+    const groupedAttrs = mapGroupBy(attrPayloads, (payload) => payload.type)
 
-    for (const [type, attrs] of Object.entries(groupedAttrs)) {
+    for (const [type, attrs] of groupedAttrs.entries()) {
       if (!attrs) continue
 
-      const maybeSpec = specs.get(type)
-      assert(maybeSpec, `Node type ${type} must be defined`)
+      const oldSpec = specs.get(type)
+      assert(oldSpec, `Node type ${type} must be defined`)
 
-      const spec = clone(maybeSpec)
-
-      if (!spec.attrs) {
-        spec.attrs = {}
-      }
+      const newSpec = { ...oldSpec, attrs: { ...oldSpec.attrs } } satisfies NodeSpec
 
       for (const attr of attrs) {
-        spec.attrs[attr.attr] = {
+        newSpec.attrs[attr.attr] = {
           default: attr.default as unknown,
           validate: attr.validate,
           splittable: attr.splittable,
-        } as AttributeSpec
+        } satisfies AttributeSpec
       }
 
-      if (spec.toDOM) {
-        spec.toDOM = wrapOutputSpecAttrs(spec.toDOM, attrs)
+      if (oldSpec.toDOM) {
+        newSpec.toDOM = wrapOutputSpecAttrs(oldSpec.toDOM, attrs)
       }
 
-      if (spec.parseDOM) {
-        spec.parseDOM = spec.parseDOM.map((rule) => wrapTagParseRuleAttrs(rule, attrs))
+      if (oldSpec.parseDOM) {
+        newSpec.parseDOM = oldSpec.parseDOM.map((rule) => wrapTagParseRuleAttrs(rule, attrs))
       }
 
-      specs = specs.update(type, spec)
+      specs = specs.update(type, newSpec)
     }
 
     return { nodes: specs, topNode: topNodeName }

package/src/extensions/plugin.ts

@@ -15,7 +15,6 @@ import {
   type StatePayload,
 } from '../facets/state'
 import type { PlainExtension } from '../types/extension'
-import { toReversed } from '../utils/array'
 
 /**
  * Adds a ProseMirror plugin to the editor.
@@ -72,7 +71,7 @@ export const pluginFacet: Facet<PluginPayload, StatePayload> = defineFacet({
 
       // An array of plugins from higher to lower priority. This matches the
       // order of plugins required by ProseMirror.
-      const reversedPlugins = toReversed(plugins)
+      const reversedPlugins = [...plugins].reverse()
 
       return { plugins: reversedPlugins }
     }

package/src/facets/command.ts

@@ -13,8 +13,14 @@ type CommandPayload = CommandCreators
 
 export const commandFacet: Facet<CommandPayload, RootPayload> = defineFacet({
   reducer: (inputs) => {
-    const commands = Object.assign({}, ...inputs) as CommandPayload
-    return { commands }
+    switch (inputs.length) {
+      case 0:
+        return { commands: {} }
+      case 1:
+        return { commands: inputs[0] }
+      default:
+        return { commands: Object.assign({}, ...inputs) as CommandCreators }
+    }
   },
   parent: rootFacet,
   singleton: true,

package/src/facets/state.spec.ts

@@ -20,9 +20,9 @@ describe('state', () => {
     const doc2: NodeJSON = { type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'highest priority' }] }] }
     const doc3: NodeJSON = { type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'lowest priority' }] }] }
 
-    const extension1 = defineDefaultState({ defaultDoc: doc1 }) // default priority
-    const extension2 = withPriority(defineDefaultState({ defaultDoc: doc2 }), Priority.highest)
-    const extension3 = withPriority(defineDefaultState({ defaultDoc: doc3 }), Priority.lowest)
+    const extension1 = defineDefaultState({ defaultContent: doc1 }) // default priority
+    const extension2 = withPriority(defineDefaultState({ defaultContent: doc2 }), Priority.highest)
+    const extension3 = withPriority(defineDefaultState({ defaultContent: doc3 }), Priority.lowest)
 
     const combinedExtension = union(defineTestExtension(), extension1, extension2, extension3)
     const { editor } = setupTestFromExtension(combinedExtension)
@@ -38,9 +38,9 @@ describe('state', () => {
     const doc2 = { type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'second' }] }] }
     const doc3 = { type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'third' }] }] }
 
-    const extension1 = defineDefaultState({ defaultDoc: doc1 })
-    const extension2 = defineDefaultState({ defaultDoc: doc2 })
-    const extension3 = defineDefaultState({ defaultDoc: doc3 })
+    const extension1 = defineDefaultState({ defaultContent: doc1 })
+    const extension2 = defineDefaultState({ defaultContent: doc2 })
+    const extension3 = defineDefaultState({ defaultContent: doc3 })
 
     const combinedExtension = union(defineTestExtension(), extension1, extension2, extension3)
     const { editor } = setupTestFromExtension(combinedExtension)

package/src/facets/state.ts

@@ -9,7 +9,6 @@ import type {
   Selection,
 } from '@prosekit/pm/state'
 
-import { toReversed } from '../utils/array'
 import { assert } from '../utils/assert'
 
 import {
@@ -37,7 +36,7 @@ export const stateFacet: Facet<StatePayload, RootPayload> = defineFacet({
 
       // An array of state payloads from higher to lower priority. This matches the
       // order of plugins required by ProseMirror.
-      const reversedCallbacks = toReversed(callbacks)
+      const reversedCallbacks = [...callbacks].reverse()
 
       for (const callback of reversedCallbacks) {
         const config = callback(ctx)

package/src/index.ts

@@ -22,6 +22,8 @@ export {
   removeNode,
   type RemoveNodeOptions,
 } from './commands/remove-node'
+export { selectAll } from './commands/select-all'
+export { selectBlock } from './commands/select-block'
 export {
   setBlockType,
   type SetBlockTypeOptions,
@@ -56,9 +58,7 @@ export {
 } from './commands/wrap'
 export type {
   MarkAction,
-  MarkBuilder,
   NodeAction,
-  NodeBuilder,
   NodeChild,
 } from './editor/action'
 export {
@@ -85,10 +85,6 @@ export {
   defineDefaultState,
   type DefaultStateOptions,
 } from './extensions/default-state'
-export {
-  defineDoc,
-  type DocExtension,
-} from './extensions/doc'
 export {
   defineDocChangeHandler,
   type DocChangeHandler,
@@ -151,6 +147,7 @@ export {
 export {
   defineBaseKeymap,
   type BaseKeymapExtension,
+  type BaseKeymapOptions,
 } from './extensions/keymap-base'
 export {
   defineMarkAttr,
@@ -184,19 +181,11 @@ export {
   type NodeViewComponentOptions,
   type NodeViewFactoryOptions,
 } from './extensions/node-view-effect'
-export {
-  defineParagraph,
-  type ParagraphExtension,
-} from './extensions/paragraph'
 export {
   definePlugin,
   pluginFacet,
   type PluginPayload,
 } from './extensions/plugin'
-export {
-  defineText,
-  type TextExtension,
-} from './extensions/text'
 export {
   defineFacet,
   type Facet,
@@ -207,12 +196,10 @@ export type {
   AnyAttrs,
   AttrSpec,
 } from './types/attrs'
-export type { BaseNodeViewOptions } from './types/base-node-view-options'
 export type {
   Extension,
   ExtensionTyping,
   ExtractCommandActions,
-  ExtractCommandAppliers,
   ExtractCommandCreators,
   ExtractCommands,
   ExtractMarkActions,
@@ -222,7 +209,6 @@ export type {
   ExtractTyping,
   PlainExtension,
   Union,
-  UnionExtension,
 } from './types/extension'
 export type {
   CommandAction,
@@ -249,11 +235,6 @@ export type { SimplifyUnion } from './types/simplify-union'
 export { assert } from './utils/assert'
 export { canUseRegexLookbehind } from './utils/can-use-regex-lookbehind'
 export { clsx } from './utils/clsx'
-export { collectChildren } from './utils/collect-children'
-export {
-  collectNodes,
-  type NodeContent,
-} from './utils/collect-nodes'
 export { containsInlineNode } from './utils/contains-inline-node'
 export { defaultBlockAt } from './utils/default-block-at'
 export { isApple } from './utils/env'
@@ -262,7 +243,6 @@ export {
   type FindParentNodeResult,
 } from './utils/find-parent-node'
 export { findParentNodeOfType } from './utils/find-parent-node-of-type'
-export { getId as _getId } from './utils/get-id'
 export { getMarkType } from './utils/get-mark-type'
 export { getNodeType } from './utils/get-node-type'
 export { isAtBlockStart } from './utils/is-at-block-start'

package/src/types/extension-command.ts

@@ -19,13 +19,6 @@ export interface CommandAction<Args extends any[] = any[]> {
    * can be executed, otherwise `false`.
    */
   canExec(...args: Args): boolean
-
-  /**
-   * An alias for `canExec`.
-   *
-   * @deprecated Use `canExec` instead.
-   */
-  canApply(...args: Args): boolean
 }
 
 export type CommandCreator<Args extends any[] = any[]> = (