@prosekit/core 0.8.7 → 0.10.0

package/src/extensions/mark-spec.spec.ts

@@ -1,26 +1,11 @@
-import type {
-  DOMOutputSpec,
-  TagParseRule,
-} from '@prosekit/pm/model'
-import formatHTML from 'diffable-html'
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import type { DOMOutputSpec, TagParseRule } from '@prosekit/pm/model'
+import { formatHTML } from 'diffable-html-snapshot'
+import { describe, expect, it } from 'vitest'
 
 import { union } from '../editor/union'
-import {
-  defineDoc,
-  defineParagraph,
-  defineText,
-  setupTestFromExtension,
-} from '../testing'
+import { defineDoc, defineParagraph, defineText, setupTestFromExtension } from '../testing'
 
-import {
-  defineMarkAttr,
-  defineMarkSpec,
-} from './mark-spec'
+import { defineMarkAttr, defineMarkSpec } from './mark-spec'
 
 describe('defineMarkSpec', () => {
   it('can merge mark specs', () => {

package/src/extensions/mark-spec.ts

@@ -1,27 +1,15 @@
-import type {
-  MarkSpec,
-  ParseRule,
-  SchemaSpec,
-} from '@prosekit/pm/model'
-import clone from 'just-clone'
+import { isNotNullish, mapGroupBy } from '@ocavue/utils'
+import type { AttributeSpec, MarkSpec, SchemaSpec } from '@prosekit/pm/model'
 import OrderedMap from 'orderedmap'
 
 import { defineFacet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import { schemaSpecFacet } from '../facets/schema-spec'
-import type {
-  AnyAttrs,
-  AttrSpec,
-} from '../types/attrs'
+import type { AnyAttrs, 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,
-} from '../utils/output-spec'
-import { isNotNullish } from '../utils/type-assertion'
+import { wrapOutputSpecAttrs, wrapParseRuleAttrs } from '../utils/output-spec'
 
 /**
  * @public
@@ -76,7 +64,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 +138,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 +171,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/mark-view-effect.ts

@@ -1,18 +1,12 @@
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-} from '@prosekit/pm/state'
+import { isNotNullish } from '@ocavue/utils'
+import { PluginKey, ProseMirrorPlugin } from '@prosekit/pm/state'
 import type { MarkViewConstructor } from '@prosekit/pm/view'
 
 import { defineFacet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { Extension } from '../types/extension'
-import { isNotNullish } from '../utils/type-assertion'
 
-import {
-  pluginFacet,
-  type PluginPayload,
-} from './plugin'
+import { pluginFacet, type PluginPayload } from './plugin'
 
 /**
  * @internal

package/src/extensions/mark-view.ts

@@ -1,17 +1,11 @@
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-} from '@prosekit/pm/state'
+import { PluginKey, ProseMirrorPlugin } from '@prosekit/pm/state'
 import type { MarkViewConstructor } from '@prosekit/pm/view'
 
 import { defineFacet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { Extension } from '../types/extension'
 
-import {
-  pluginFacet,
-  type PluginPayload,
-} from './plugin'
+import { pluginFacet, type PluginPayload } from './plugin'
 
 export interface MarkViewOptions {
   name: string

package/src/extensions/node-spec.spec.ts

@@ -1,29 +1,13 @@
-import type {
-  DOMOutputSpec,
-  Schema,
-  TagParseRule,
-} from '@prosekit/pm/model'
-import formatHTML from 'diffable-html'
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import type { DOMOutputSpec, Schema, TagParseRule } from '@prosekit/pm/model'
+import { formatHTML } from 'diffable-html-snapshot'
+import { describe, expect, it } from 'vitest'
 
 import { union } from '../editor/union'
-import {
-  defineDoc,
-  defineParagraph,
-  defineText,
-  setupTestFromExtension,
-} from '../testing'
+import { defineDoc, defineParagraph, defineText, setupTestFromExtension } from '../testing'
 
 import { defineHistory } from './history'
 import { defineBaseKeymap } from './keymap-base'
-import {
-  defineNodeAttr,
-  defineNodeSpec,
-} from './node-spec'
+import { defineNodeAttr, defineNodeSpec } from './node-spec'
 
 describe('defineNodeSpec', () => {
   it('can merge node specs', () => {

package/src/extensions/node-spec.ts

@@ -1,27 +1,15 @@
-import type {
-  AttributeSpec,
-  NodeSpec,
-  SchemaSpec,
-} from '@prosekit/pm/model'
-import clone from 'just-clone'
+import { isNotNullish, mapGroupBy } from '@ocavue/utils'
+import type { AttributeSpec, NodeSpec, SchemaSpec } from '@prosekit/pm/model'
 import OrderedMap from 'orderedmap'
 
 import { defineFacet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import { schemaSpecFacet } from '../facets/schema-spec'
-import type {
-  AnyAttrs,
-  AttrSpec,
-} from '../types/attrs'
+import type { AnyAttrs, 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,
-} from '../utils/output-spec'
-import { isNotNullish } from '../utils/type-assertion'
+import { wrapOutputSpecAttrs, wrapTagParseRuleAttrs } from '../utils/output-spec'
 
 /**
  * @public
@@ -93,9 +81,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 +161,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/node-view-effect.ts

@@ -1,18 +1,12 @@
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-} from '@prosekit/pm/state'
+import { isNotNullish } from '@ocavue/utils'
+import { PluginKey, ProseMirrorPlugin } from '@prosekit/pm/state'
 import type { NodeViewConstructor } from '@prosekit/pm/view'
 
 import { defineFacet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { Extension } from '../types/extension'
-import { isNotNullish } from '../utils/type-assertion'
 
-import {
-  pluginFacet,
-  type PluginPayload,
-} from './plugin'
+import { pluginFacet, type PluginPayload } from './plugin'
 
 /**
  * @internal

package/src/extensions/node-view.ts

@@ -1,17 +1,11 @@
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-} from '@prosekit/pm/state'
+import { PluginKey, ProseMirrorPlugin } from '@prosekit/pm/state'
 import type { NodeViewConstructor } from '@prosekit/pm/view'
 
 import { defineFacet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { Extension } from '../types/extension'
 
-import {
-  pluginFacet,
-  type PluginPayload,
-} from './plugin'
+import { pluginFacet, type PluginPayload } from './plugin'
 
 export interface NodeViewOptions {
   name: string

package/src/extensions/plugin.spec.ts

@@ -1,22 +1,9 @@
-import {
-  Plugin,
-  PluginKey,
-} from '@prosekit/pm/state'
-import {
-  describe,
-  expect,
-  it,
-  vi,
-} from 'vitest'
+import { Plugin, PluginKey } from '@prosekit/pm/state'
+import { describe, expect, it, vi } from 'vitest'
 
 import { union } from '../editor/union'
 import { withPriority } from '../editor/with-priority'
-import {
-  defineDoc,
-  defineParagraph,
-  defineText,
-  setupTestFromExtension,
-} from '../testing'
+import { defineDoc, defineParagraph, defineText, setupTestFromExtension } from '../testing'
 import { Priority } from '../types/priority'
 
 import { definePlugin } from './plugin'

package/src/extensions/plugin.ts

@@ -1,21 +1,11 @@
 import type { Schema } from '@prosekit/pm/model'
-import {
-  Plugin,
-  type ProseMirrorPlugin,
-} from '@prosekit/pm/state'
+import { Plugin, type ProseMirrorPlugin } from '@prosekit/pm/state'
 
 import { ProseKitError } from '../error'
-import {
-  defineFacet,
-  type Facet,
-} from '../facets/facet'
+import { defineFacet, type Facet } from '../facets/facet'
 import { defineFacetPayload } from '../facets/facet-extension'
-import {
-  stateFacet,
-  type StatePayload,
-} from '../facets/state'
+import { stateFacet, 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 +62,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/base-extension.ts

@@ -1,9 +1,6 @@
 import type { Schema } from '@prosekit/pm/model'
 
-import type {
-  Extension,
-  ExtensionTyping,
-} from '../types/extension'
+import type { Extension, ExtensionTyping } from '../types/extension'
 import { Priority } from '../types/priority'
 
 import type { Facet } from './facet'

package/src/facets/command.ts

@@ -1,20 +1,20 @@
 import type { CommandCreators } from '../types/extension-command'
 
-import {
-  defineFacet,
-  type Facet,
-} from './facet'
-import {
-  rootFacet,
-  type RootPayload,
-} from './root'
+import { defineFacet, type Facet } from './facet'
+import { rootFacet, type RootPayload } from './root'
 
 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/facet-extension.spec.ts

@@ -1,22 +1,11 @@
-import {
-  describe,
-  expect,
-  it,
-  vi,
-} from 'vitest'
+import { isNotNullish } from '@ocavue/utils'
+import { describe, expect, it, vi } from 'vitest'
 
 import { Priority } from '../types/priority'
-import { isNotNullish } from '../utils/type-assertion'
 
-import {
-  defineFacet,
-  Facet,
-} from './facet'
+import { defineFacet, Facet } from './facet'
 import { FacetExtensionImpl } from './facet-extension'
-import {
-  subtractFacetNode,
-  unionFacetNode,
-} from './facet-node'
+import { subtractFacetNode, unionFacetNode } from './facet-node'
 import type { FacetReducer } from './facet-types'
 import { UnionExtensionImpl } from './union-extension'
 

package/src/facets/facet-node.spec.ts

@@ -1,16 +1,9 @@
-import {
-  expect,
-  test,
-} from 'vitest'
+import { expect, test } from 'vitest'
 
 import { Priority } from '../types/priority'
 
 import { Facet } from './facet'
-import {
-  FacetNode,
-  subtractFacetNode,
-  unionFacetNode,
-} from './facet-node'
+import { FacetNode, subtractFacetNode, unionFacetNode } from './facet-node'
 
 const sum = (input: number[]) => input.reduce((acc, cur) => acc + cur, 0)
 

package/src/facets/facet-node.ts

@@ -1,16 +1,11 @@
+import { isNotNullish } from '@ocavue/utils'
+
 import { Priority } from '../types/priority'
-import {
-  arraySubtract,
-  uniqPush,
-} from '../utils/array'
+import { arraySubtract, uniqPush } from '../utils/array'
 import { assert } from '../utils/assert'
-import { isNotNullish } from '../utils/type-assertion'
 
 import type { Facet } from './facet'
-import type {
-  FacetReducer,
-  Tuple5,
-} from './facet-types'
+import type { FacetReducer, Tuple5 } from './facet-types'
 import type { RootOutput } from './root'
 
 function zip5<T>(

package/src/facets/facet.spec.ts

@@ -1,7 +1,4 @@
-import {
-  expect,
-  test,
-} from 'vitest'
+import { expect, test } from 'vitest'
 
 import { Facet } from './facet'
 

package/src/facets/schema-spec.ts

@@ -1,14 +1,7 @@
-import type {
-  MarkSpec,
-  NodeSpec,
-  SchemaSpec,
-} from '@prosekit/pm/model'
+import type { MarkSpec, NodeSpec, SchemaSpec } from '@prosekit/pm/model'
 import OrderedMap from 'orderedmap'
 
-import {
-  defineFacet,
-  type Facet,
-} from './facet'
+import { defineFacet, type Facet } from './facet'
 import { schemaFacet } from './schema'
 
 export const schemaSpecFacet: Facet<SchemaSpec, SchemaSpec> = defineFacet({

package/src/facets/schema.ts

@@ -1,18 +1,9 @@
-import {
-  Schema,
-  type SchemaSpec,
-} from '@prosekit/pm/model'
+import { Schema, type SchemaSpec } from '@prosekit/pm/model'
 
 import { assert } from '../utils/assert'
 
-import {
-  defineFacet,
-  type Facet,
-} from './facet'
-import {
-  rootFacet,
-  type RootPayload,
-} from './root'
+import { defineFacet, type Facet } from './facet'
+import { rootFacet, type RootPayload } from './root'
 
 export const schemaFacet: Facet<SchemaSpec, RootPayload> = defineFacet({
   reducer: (specs) => {

package/src/facets/state.spec.ts

@@ -1,16 +1,9 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { union } from '../editor/union'
 import { withPriority } from '../editor/with-priority'
 import { defineDefaultState } from '../extensions/default-state'
-import {
-  defineTestExtension,
-  setupTestFromExtension,
-} from '../testing'
+import { defineTestExtension, setupTestFromExtension } from '../testing'
 import type { NodeJSON } from '../types/model'
 import { Priority } from '../types/priority'
 
@@ -20,9 +13,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 +31,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)