@prosekit/core 0.8.7 → 0.10.0

package/src/commands/set-node-attrs.spec.ts

@@ -0,0 +1,129 @@
+import { describe, expect, it } from 'vitest'
+
+import { setupTest } from '../testing'
+
+import { setNodeAttrs } from './set-node-attrs'
+
+describe('setNodeAttrs', () => {
+  it('should set attributes on a code block node', () => {
+    const { editor, n } = setupTest()
+
+    editor.set(n.doc(n.codeBlock('const x = 1')))
+
+    // Get the initial language attribute (should be empty string by default)
+    expect(editor.state.doc.firstChild?.attrs.language).toBe('')
+
+    // Set the language attribute
+    const command = setNodeAttrs({
+      type: 'codeBlock',
+      attrs: { language: 'typescript' },
+    })
+
+    expect(editor.exec(command)).toBe(true)
+    expect(editor.state.doc.firstChild?.attrs.language).toBe('typescript')
+  })
+
+  it('should set multiple attributes at once', () => {
+    const { editor, n } = setupTest()
+
+    editor.set(n.doc(n.codeBlock('const x = 1')))
+
+    // Verify initial state
+    expect(editor.state.doc.firstChild?.attrs).toMatchObject({
+      language: '',
+      lineNumbers: false,
+    })
+
+    // Set multiple attributes at once
+    const command = setNodeAttrs({
+      type: 'codeBlock',
+      attrs: { language: 'javascript', lineNumbers: true },
+    })
+
+    editor.exec(command)
+
+    // Verify both attributes were set
+    expect(editor.state.doc.firstChild?.attrs).toMatchObject({
+      language: 'javascript',
+      lineNumbers: true,
+    })
+  })
+
+  it('should return false when node type does not match', () => {
+    const { editor, n } = setupTest()
+
+    editor.set(n.doc(n.paragraph('Hello world')))
+
+    const command = setNodeAttrs({
+      type: 'codeBlock',
+      attrs: { language: 'typescript' },
+    })
+
+    // Should return false because paragraph is not a codeBlock
+    expect(editor.exec(command)).toBe(false)
+  })
+
+  it('should set attributes at a specific position', () => {
+    const { editor, n } = setupTest()
+
+    editor.set(
+      n.doc(
+        /*0*/
+        n.codeBlock(/*1*/ 'A' /*2*/),
+        /*3*/
+        n.codeBlock(/*4*/ 'B' /*5*/),
+        /*6*/
+      ),
+    )
+
+    // Set attribute on the second code block (position after first block)
+    const command = setNodeAttrs({
+      type: 'codeBlock',
+      attrs: { language: 'python' },
+      pos: 3, // Position of second code block
+    })
+
+    editor.exec(command)
+
+    // First block should still have default language
+    expect(editor.state.doc.child(0).attrs.language).toBe('')
+    // Second block should have the new language
+    expect(editor.state.doc.child(1).attrs.language).toBe('python')
+  })
+
+  it('should handle cursor inside a node', () => {
+    const { editor, n } = setupTest()
+
+    editor.set(n.doc(n.codeBlock('const<a> x = 1')))
+
+    const command = setNodeAttrs({
+      type: 'codeBlock',
+      attrs: { language: 'typescript' },
+    })
+
+    editor.exec(command)
+
+    expect(editor.state.doc.firstChild?.attrs.language).toBe('typescript')
+  })
+
+  it('should set attrs on wrapping node containing selection', () => {
+    const { editor, n } = setupTest()
+
+    editor.set(
+      n.doc(
+        n.blockquote(
+          n.paragraph('Hello<a> world<b>'),
+        ),
+      ),
+    )
+
+    const command = setNodeAttrs({
+      type: 'blockquote',
+      attrs: { variant: 'fancy' },
+    })
+
+    // Should find the blockquote wrapping the selection
+    expect(editor.exec(command)).toBe(true)
+    expect(editor.state.doc.firstChild?.attrs.variant).toBe('fancy')
+  })
+})

package/src/commands/set-node-attrs.ts

@@ -1,9 +1,7 @@
-import type {
-  Attrs,
-  NodeType,
-} from '@prosekit/pm/model'
+import type { Attrs, NodeType } from '@prosekit/pm/model'
 import type { Command } from '@prosekit/pm/state'
 
+import { findParentNodeOfType } from '../utils/find-parent-node-of-type'
 import { getNodeTypes } from '../utils/get-node-types'
 
 /**
@@ -12,8 +10,6 @@ import { getNodeTypes } from '../utils/get-node-types'
 export interface SetNodeAttrsOptions {
   /**
    * The type of node to set the attributes of.
-   *
-   * If current node is not of this type, the command will do nothing.
    */
   type: string | NodeType | string[] | NodeType[]
 
@@ -23,43 +19,46 @@ export interface SetNodeAttrsOptions {
   attrs: Attrs
 
   /**
-   * The position of the node. Defaults to the position of the wrapping node
-   * containing the current selection.
+   * The document position of the node to update. If not provided, the command
+   * will find the closest ancestor node that matches the type based on the
+   * anchor position of the selection.
    */
   pos?: number
 }
 
 /**
- * Returns a command that set the attributes of the current node.
+ * Returns a command that sets the attributes of the current node.
+ *
+ * @param options
  *
  * @public
  */
-export function setNodeAttrs(options: SetNodeAttrsOptions): Command {
+export function setNodeAttrs({ type, attrs, pos }: SetNodeAttrsOptions): Command {
   return (state, dispatch) => {
-    const nodeTypes = getNodeTypes(state.schema, options.type)
-    const from = options.pos ?? state.selection.from
-    const to = options.pos ?? state.selection.to
-    const positions: number[] = []
+    let updatePos: number
 
-    state.doc.nodesBetween(from, to, (node, pos) => {
-      if (nodeTypes.includes(node.type)) {
-        positions.push(pos)
+    if (pos == null) {
+      const found = findParentNodeOfType(type, state.selection.$anchor)
+      if (!found) {
+        return false
       }
-      if (!dispatch && positions.length > 0) {
+      updatePos = found.pos
+    } else {
+      const found = state.doc.nodeAt(pos)
+      if (!found) {
         return false
       }
-    })
-
-    if (positions.length === 0) {
-      return false
+      const nodeTypes = getNodeTypes(state.schema, type)
+      if (!nodeTypes.includes(found.type)) {
+        return false
+      }
+      updatePos = pos
     }
 
     if (dispatch) {
       const { tr } = state
-      for (const pos of positions) {
-        for (const [key, value] of Object.entries(options.attrs)) {
-          tr.setNodeAttribute(pos, key, value)
-        }
+      for (const [key, value] of Object.entries(attrs)) {
+        tr.setNodeAttribute(updatePos, key, value)
       }
       dispatch(tr)
     }

package/src/commands/toggle-mark.ts

@@ -1,8 +1,5 @@
 import { toggleMark as baseToggleMark } from '@prosekit/pm/commands'
-import type {
-  Attrs,
-  MarkType,
-} from '@prosekit/pm/model'
+import type { Attrs, MarkType } from '@prosekit/pm/model'
 import type { Command } from '@prosekit/pm/state'
 
 import type { CommandCreator } from '../types/extension-command'

package/src/commands/toggle-node.ts

@@ -1,8 +1,5 @@
 import { setBlockType } from '@prosekit/pm/commands'
-import type {
-  Attrs,
-  NodeType,
-} from '@prosekit/pm/model'
+import type { Attrs, NodeType } from '@prosekit/pm/model'
 import type { Command } from '@prosekit/pm/state'
 
 import { getNodeType } from '../utils/get-node-type'
@@ -24,7 +21,7 @@ export interface ToggleNodeOptions {
 }
 
 /**
- * Returns a command that set the selected textblocks to the given node type
+ * Returns a command that sets the selected textblocks to the given node type
  * with the given attributes.
  *
  * @param options

package/src/commands/toggle-wrap.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { setupTest } from '../testing'
 

package/src/commands/toggle-wrap.ts

@@ -1,8 +1,5 @@
 import { lift } from '@prosekit/pm/commands'
-import type {
-  Attrs,
-  NodeType,
-} from '@prosekit/pm/model'
+import type { Attrs, NodeType } from '@prosekit/pm/model'
 import type { Command } from '@prosekit/pm/state'
 
 import { isNodeActive } from '../utils/is-node-active'

package/src/commands/unset-block-type.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { setupTest } from '../testing'
 

package/src/commands/unset-block-type.ts

@@ -1,11 +1,5 @@
-import {
-  Fragment,
-  Slice,
-} from '@prosekit/pm/model'
-import type {
-  Command,
-  Transaction,
-} from '@prosekit/pm/state'
+import { Fragment, Slice } from '@prosekit/pm/model'
+import type { Command, Transaction } from '@prosekit/pm/state'
 import { ReplaceAroundStep } from '@prosekit/pm/transform'
 
 import type { CommandCreator } from '../types/extension-command'

package/src/commands/unset-mark.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { setupTest } from '../testing'
 

package/src/commands/wrap.ts

@@ -1,7 +1,4 @@
-import type {
-  Attrs,
-  NodeType,
-} from '@prosekit/pm/model'
+import type { Attrs, NodeType } from '@prosekit/pm/model'
 import type { Command } from '@prosekit/pm/state'
 import { findWrapping } from '@prosekit/pm/transform'
 
@@ -16,11 +13,6 @@ export interface WrapOptions {
    */
   type: NodeType | string
 
-  /**
-   * @deprecated Use `nodeSpec` instead.
-   */
-  nodeType?: NodeType
-
   /**
    * Optional attributes to apply to the node.
    */
@@ -40,7 +32,7 @@ export function wrap(options: WrapOptions): Command {
     const range = $from.blockRange($to)
     if (!range) return false
 
-    const nodeType = getNodeType(state.schema, options.nodeType || options.type)
+    const nodeType = getNodeType(state.schema, options.type)
     const wrapping = findWrapping(range, nodeType, options.attrs)
     if (!wrapping) return false
 

package/src/editor/action.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { setupTest } from '../testing'
 import { jsonFromNode } from '../utils/parse'
@@ -22,7 +18,7 @@ describe('NodeAction', () => {
   it('can apply node with attrs', () => {
     expect(n.codeBlock({ language: 'javascript' }, 'foo').toJSON()).toEqual({
       type: 'codeBlock',
-      attrs: { language: 'javascript' },
+      attrs: { language: 'javascript', lineNumbers: false },
       content: [{ text: 'foo', type: 'text' }],
     })
   })

package/src/editor/action.ts

@@ -1,13 +1,6 @@
-import type {
-  Attrs,
-  Mark,
-  MarkType,
-  NodeType,
-  ProseMirrorNode,
-  Schema,
-} from '@prosekit/pm/model'
+import { mapValues } from '@ocavue/utils'
+import type { Attrs, Mark, MarkType, NodeType, ProseMirrorNode, Schema } from '@prosekit/pm/model'
 import type { EditorState } from '@prosekit/pm/state'
-import mapValues from 'just-map-values'
 
 import { ProseKitError } from '../error'
 import type { AnyAttrs } from '../types/attrs'
@@ -79,16 +72,6 @@ export interface MarkAction<Attrs extends AnyAttrs = AnyAttrs> {
   isActive: (attrs?: Attrs) => boolean
 }
 
-/**
- * @deprecated Use type {@link NodeAction} instead.
- */
-export type NodeBuilder = NodeAction
-
-/**
- * @deprecated Use type {@link MarkAction} instead.
- */
-export type MarkBuilder = MarkAction
-
 /**
  * @internal
  */

package/src/editor/editor.spec.ts

@@ -1,15 +1,8 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { insertText } from '../commands/insert-text'
 import { wrap } from '../commands/wrap'
-import {
-  defineTestExtension,
-  setupTest,
-} from '../testing'
+import { defineTestExtension, setupTest } from '../testing'
 import type { NodeJSON } from '../types/model'
 
 import { createEditor } from './editor'

package/src/editor/editor.ts

@@ -1,28 +1,12 @@
-import type {
-  ProseMirrorNode,
-  Schema,
-} from '@prosekit/pm/model'
-import {
-  EditorState,
-  type Command,
-  type Plugin,
-  type Selection,
-  type Transaction,
-} from '@prosekit/pm/state'
-import {
-  EditorView,
-  type DirectEditorProps,
-  type EditorProps,
-} from '@prosekit/pm/view'
+import { isDeepEqual } from '@ocavue/utils'
+import type { ProseMirrorNode, Schema } from '@prosekit/pm/model'
+import { EditorState, type Command, type Plugin, type Selection, type Transaction } from '@prosekit/pm/state'
+import { EditorView, type DirectEditorProps, type EditorProps } from '@prosekit/pm/view'
 
 import { ProseKitError } from '../error'
 import { defineDefaultState } from '../extensions/default-state'
 import type { BaseExtension } from '../facets/base-extension'
-import {
-  subtractFacetNode,
-  unionFacetNode,
-  type FacetNode,
-} from '../facets/facet-node'
+import { subtractFacetNode, unionFacetNode, type FacetNode } from '../facets/facet-node'
 import type {
   Extension,
   ExtractCommandActions,
@@ -31,32 +15,13 @@ import type {
   ExtractNodeActions,
   ExtractNodeNames,
 } from '../types/extension'
-import type {
-  CommandAction,
-  CommandCreator,
-} from '../types/extension-command'
-import type {
-  NodeJSON,
-  SelectionJSON,
-} from '../types/model'
+import type { CommandAction, CommandCreator } from '../types/extension-command'
+import type { NodeJSON, SelectionJSON } from '../types/model'
 import { assert } from '../utils/assert'
-import { deepEquals } from '../utils/deep-equals'
-import {
-  getEditorContentDoc,
-  getEditorSelection,
-} from '../utils/editor-content'
-import {
-  htmlFromNode,
-  jsonFromNode,
-  type DOMDocumentOptions,
-} from '../utils/parse'
-
-import {
-  createMarkActions,
-  createNodeActions,
-  type MarkAction,
-  type NodeAction,
-} from './action'
+import { getEditorContentDoc, getEditorSelection } from '../utils/editor-content'
+import { htmlFromNode, jsonFromNode, type DOMDocumentOptions } from '../utils/parse'
+
+import { createMarkActions, createNodeActions, type MarkAction, type NodeAction } from './action'
 import { union } from './union'
 
 /**
@@ -70,25 +35,9 @@ export interface EditorOptions<E extends Extension> {
 
   /**
    * 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.
-   */
-  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.
+   * ProseMirror node JSON object, an HTML string, or a DOM element instance.
    */
-  defaultHTML?: string | HTMLElement
+  defaultContent?: NodeJSON | string | Element
 
   /**
    * A JSON object representing the starting selection to use when creating the
@@ -108,7 +57,7 @@ export interface getDocHTMLOptions extends DOMDocumentOptions {}
 export function setupEditorExtension<E extends Extension>(
   options: EditorOptions<E>,
 ): E {
-  if (options.defaultContent || options.defaultDoc || options.defaultHTML) {
+  if (options.defaultContent) {
     return union(
       options.extension,
       defineDefaultState(options),
@@ -176,7 +125,7 @@ export class EditorInstance {
     return this.getState().doc
   }
 
-  private getProp<PropName extends keyof EditorProps>(propName: PropName): EditorProps[PropName] | undefined {
+  private getProp<PropName extends keyof EditorProps>(propName: PropName): Partial<EditorProps>[PropName] {
     return this.view?.someProp(propName) ?? this.directEditorProps[propName]
   }
 
@@ -197,7 +146,7 @@ export class EditorInstance {
   }
 
   public setContent(
-    content: NodeJSON | string | HTMLElement | ProseMirrorNode,
+    content: NodeJSON | string | Element | ProseMirrorNode,
     selection?: SelectionJSON | Selection | 'start' | 'end',
   ): void {
     const doc = getEditorContentDoc(this.schema, content)
@@ -226,7 +175,7 @@ export class EditorInstance {
   }
 
   /**
-   * Return a HTML string representing the editor's current document.
+   * Return an HTML string representing the editor's current document.
    */
   public getDocHTML = (options?: getDocHTMLOptions): string => {
     const serializer = this.getProp('clipboardSerializer')
@@ -264,14 +213,14 @@ export class EditorInstance {
     const newPayload = this.tree.getRootOutput()
     const newPlugins = [...(newPayload?.state?.plugins ?? [])]
 
-    if (!deepEquals(oldPlugins, newPlugins)) {
+    if (!isDeepEqual(oldPlugins, newPlugins)) {
       const state = view.state.reconfigure({ plugins: newPlugins })
       view.updateState(state)
     }
 
     if (
       newPayload?.commands
-      && !deepEquals(oldPayload?.commands, newPayload?.commands)
+      && !isDeepEqual(oldPayload?.commands, newPayload?.commands)
     ) {
       const commands = newPayload.commands
       const names = Object.keys(commands)
@@ -306,10 +255,14 @@ export class EditorInstance {
 
   public mount(place: HTMLElement): void {
     if (this.view) {
+      // If the editor is already mounted to the same DOM element, do nothing
+      if (this.view.dom === place) return
+      // If the editor is already mounted to a different element, throw an error
       throw new ProseKitError('Editor is already mounted')
     }
     this.view = new EditorView({ mount: place }, this.directEditorProps)
     this.afterMounted.forEach((callback) => callback())
+    this.afterMounted.length = 0
   }
 
   public unmount(): void {
@@ -374,7 +327,6 @@ export class EditorInstance {
       return this.canExec(command)
     }
 
-    action.canApply = canExec
     action.canExec = canExec
 
     this.commands[name] = action as CommandAction
@@ -437,12 +389,14 @@ export class Editor<E extends Extension = any> {
   }
 
   /**
-   * Mount the editor to the given HTML element.
-   * Pass `null` or `undefined` to unmount the editor.
+   * Mount the editor to the given HTML element. Pass `null` or `undefined` to
+   * unmount the editor. When an element is passed, this method returns a
+   * function to unmount the editor.
    */
-  mount = (place: HTMLElement | null | undefined): void => {
+  mount = (place: HTMLElement | null | undefined): void | VoidFunction => {
     if (place) {
       this.instance.mount(place)
+      return this.unmount
     } else {
       this.instance.unmount()
     }
@@ -496,7 +450,7 @@ export class Editor<E extends Extension = any> {
    *   - A ProseMirror node instance
    *   - A ProseMirror node JSON object
    *   - An HTML string
-   *   - An HTML element instance
+   *   - A DOM element instance
    * @param selection - Optional. Specifies the new selection. It can be one of the following:
    *   - A ProseMirror selection instance
    *   - A ProseMirror selection JSON object
@@ -504,7 +458,7 @@ export class Editor<E extends Extension = any> {
    *   - The string "end" (to set selection at the end)
    */
   setContent = (
-    content: ProseMirrorNode | NodeJSON | string | HTMLElement,
+    content: ProseMirrorNode | NodeJSON | string | Element,
     selection?: SelectionJSON | Selection | 'start' | 'end',
   ): void => {
     return this.instance.setContent(content, selection)
@@ -518,7 +472,7 @@ export class Editor<E extends Extension = any> {
   }
 
   /**
-   * Return a HTML string representing the editor's current document.
+   * Return an HTML string representing the editor's current document.
    */
   public getDocHTML = (options?: getDocHTMLOptions): string => {
     return this.instance.getDocHTML(options)

package/src/editor/union.spec.ts

@@ -1,10 +1,6 @@
 import type { Attrs } from '@prosekit/pm/model'
 import type { Command } from '@prosekit/pm/state'
-import {
-  describe,
-  expectTypeOf,
-  it,
-} from 'vitest'
+import { describe, expectTypeOf, it } from 'vitest'
 
 import { defineCommands } from '../extensions/command'
 import { defineMarkSpec } from '../extensions/mark-spec'

package/src/editor/union.ts

@@ -1,9 +1,6 @@
 import type { BaseExtension } from '../facets/base-extension'
 import { UnionExtensionImpl } from '../facets/union-extension'
-import type {
-  Extension,
-  Union,
-} from '../types/extension'
+import type { Extension, Union } from '../types/extension'
 import { assert } from '../utils/assert'
 
 /**

package/src/extensions/clipboard-serializer.ts

@@ -1,25 +1,13 @@
-import {
-  DOMSerializer,
-  type DOMOutputSpec,
-  type Mark,
-  type ProseMirrorNode,
-  type Schema,
-} from '@prosekit/pm/model'
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-} from '@prosekit/pm/state'
+import { isNotNullish } from '@ocavue/utils'
+import { DOMSerializer, type DOMOutputSpec, type Mark, type ProseMirrorNode, type Schema } from '@prosekit/pm/model'
+import { PluginKey, ProseMirrorPlugin } from '@prosekit/pm/state'
 
 import { defineFacet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { AnyFunction } from '../types/any-function'
 import type { PlainExtension } from '../types/extension'
-import { isNotNullish } from '../utils/type-assertion'
 
-import {
-  pluginFacet,
-  type PluginPayload,
-} from './plugin'
+import { pluginFacet, type PluginPayload } from './plugin'
 
 type SerializeFragmentFunction = typeof DOMSerializer.prototype.serializeFragment
 type SerializeNodeFunction = typeof DOMSerializer.prototype.serializeNode