@tiptap/core 2.0.0-beta.21 → 2.0.0-beta.211

package/src/helpers/getMarkRange.ts

@@ -1,34 +1,67 @@
-import { MarkType, ResolvedPos } from 'prosemirror-model'
+import { Mark as ProseMirrorMark, MarkType, ResolvedPos } from '@tiptap/pm/model'
+
 import { Range } from '../types'
+import { objectIncludes } from '../utilities/objectIncludes'
+
+function findMarkInSet(
+  marks: ProseMirrorMark[],
+  type: MarkType,
+  attributes: Record<string, any> = {},
+): ProseMirrorMark | undefined {
+  return marks.find(item => {
+    return item.type === type && objectIncludes(item.attrs, attributes)
+  })
+}
+
+function isMarkInSet(
+  marks: ProseMirrorMark[],
+  type: MarkType,
+  attributes: Record<string, any> = {},
+): boolean {
+  return !!findMarkInSet(marks, type, attributes)
+}
 
-export default function getMarkRange($pos: ResolvedPos, type: MarkType): Range | void {
+export function getMarkRange(
+  $pos: ResolvedPos,
+  type: MarkType,
+  attributes: Record<string, any> = {},
+): Range | void {
   if (!$pos || !type) {
     return
   }
 
-  const start = $pos.parent.childAfter($pos.parentOffset)
+  let start = $pos.parent.childAfter($pos.parentOffset)
+
+  if ($pos.parentOffset === start.offset && start.offset !== 0) {
+    start = $pos.parent.childBefore($pos.parentOffset)
+  }
 
   if (!start.node) {
     return
   }
 
-  const link = start.node.marks.find(mark => mark.type === type)
+  const mark = findMarkInSet([...start.node.marks], type, attributes)
 
-  if (!link) {
+  if (!mark) {
     return
   }
 
-  let startIndex = $pos.index()
+  let startIndex = start.index
   let startPos = $pos.start() + start.offset
   let endIndex = startIndex + 1
   let endPos = startPos + start.node.nodeSize
 
-  while (startIndex > 0 && link.isInSet($pos.parent.child(startIndex - 1).marks)) {
+  findMarkInSet([...start.node.marks], type, attributes)
+
+  while (startIndex > 0 && mark.isInSet($pos.parent.child(startIndex - 1).marks)) {
     startIndex -= 1
     startPos -= $pos.parent.child(startIndex).nodeSize
   }
 
-  while (endIndex < $pos.parent.childCount && link.isInSet($pos.parent.child(endIndex).marks)) {
+  while (
+    endIndex < $pos.parent.childCount
+    && isMarkInSet([...$pos.parent.child(endIndex).marks], type, attributes)
+  ) {
     endPos += $pos.parent.child(endIndex).nodeSize
     endIndex += 1
   }

package/src/helpers/getMarkType.ts

@@ -1,7 +1,13 @@
-import { MarkType, Schema } from 'prosemirror-model'
+import { MarkType, Schema } from '@tiptap/pm/model'
 
-export default function getMarkType(nameOrType: string | MarkType, schema: Schema): MarkType {
+export function getMarkType(nameOrType: string | MarkType, schema: Schema): MarkType {
   if (typeof nameOrType === 'string') {
+    if (!schema.marks[nameOrType]) {
+      throw Error(
+        `There is no mark type named '${nameOrType}'. Maybe you forgot to add the extension?`,
+      )
+    }
+
     return schema.marks[nameOrType]
   }
 

package/src/helpers/getMarksBetween.ts

@@ -1,16 +1,40 @@
-import { EditorState } from 'prosemirror-state'
+import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+
 import { MarkRange } from '../types'
+import { getMarkRange } from './getMarkRange'
+
+export function getMarksBetween(from: number, to: number, doc: ProseMirrorNode): MarkRange[] {
+  const marks: MarkRange[] = []
+
+  // get all inclusive marks on empty selection
+  if (from === to) {
+    doc
+      .resolve(from)
+      .marks()
+      .forEach(mark => {
+        const $pos = doc.resolve(from - 1)
+        const range = getMarkRange($pos, mark.type)
 
-export default function getMarksBetween(from: number, to: number, state: EditorState): MarkRange[] {
-  let marks: MarkRange[] = []
+        if (!range) {
+          return
+        }
 
-  state.doc.nodesBetween(from, to, (node, pos) => {
-    marks = [...marks, ...node.marks.map(mark => ({
-      from: pos,
-      to: pos + node.nodeSize,
-      mark,
-    }))]
-  })
+        marks.push({
+          mark,
+          ...range,
+        })
+      })
+  } else {
+    doc.nodesBetween(from, to, (node, pos) => {
+      marks.push(
+        ...node.marks.map(mark => ({
+          from: pos,
+          to: pos + node.nodeSize,
+          mark,
+        })),
+      )
+    })
+  }
 
   return marks
 }

package/src/helpers/getNodeAttributes.ts

@@ -1,24 +1,25 @@
-import { EditorState } from 'prosemirror-state'
-import { Node, NodeType } from 'prosemirror-model'
-import getNodeType from './getNodeType'
-import { AnyObject } from '../types'
+import { Node, NodeType } from '@tiptap/pm/model'
+import { EditorState } from '@tiptap/pm/state'
 
-export default function getNodeAttributes(state: EditorState, typeOrName: string | NodeType): AnyObject {
+import { getNodeType } from './getNodeType'
+
+export function getNodeAttributes(
+  state: EditorState,
+  typeOrName: string | NodeType,
+): Record<string, any> {
   const type = getNodeType(typeOrName, state.schema)
   const { from, to } = state.selection
-  let nodes: Node[] = []
+  const nodes: Node[] = []
 
   state.doc.nodesBetween(from, to, node => {
-    nodes = [...nodes, node]
+    nodes.push(node)
   })
 
-  const node = nodes
-    .reverse()
-    .find(nodeItem => nodeItem.type.name === type.name)
+  const node = nodes.reverse().find(nodeItem => nodeItem.type.name === type.name)
 
-  if (node) {
-    return { ...node.attrs }
+  if (!node) {
+    return {}
   }
 
-  return {}
+  return { ...node.attrs }
 }

package/src/helpers/getNodeType.ts

@@ -1,7 +1,13 @@
-import { NodeType, Schema } from 'prosemirror-model'
+import { NodeType, Schema } from '@tiptap/pm/model'
 
-export default function getNodeType(nameOrType: string | NodeType, schema: Schema): NodeType {
+export function getNodeType(nameOrType: string | NodeType, schema: Schema): NodeType {
   if (typeof nameOrType === 'string') {
+    if (!schema.nodes[nameOrType]) {
+      throw Error(
+        `There is no node type named '${nameOrType}'. Maybe you forgot to add the extension?`,
+      )
+    }
+
     return schema.nodes[nameOrType]
   }
 

package/src/helpers/getRenderedAttributes.ts

@@ -1,8 +1,12 @@
-import { Node, Mark } from 'prosemirror-model'
-import { ExtensionAttribute, AnyObject } from '../types'
-import mergeAttributes from '../utilities/mergeAttributes'
+import { Mark, Node } from '@tiptap/pm/model'
 
-export default function getRenderedAttributes(nodeOrMark: Node | Mark, extensionAttributes: ExtensionAttribute[]): AnyObject {
+import { ExtensionAttribute } from '../types'
+import { mergeAttributes } from '../utilities/mergeAttributes'
+
+export function getRenderedAttributes(
+  nodeOrMark: Node | Mark,
+  extensionAttributes: ExtensionAttribute[],
+): Record<string, any> {
   return extensionAttributes
     .filter(item => item.attribute.rendered)
     .map(item => {
@@ -14,7 +18,5 @@ export default function getRenderedAttributes(nodeOrMark: Node | Mark, extension
 
       return item.attribute.renderHTML(nodeOrMark.attrs) || {}
     })
-    .reduce((attributes, attribute) => {
-      return mergeAttributes(attributes, attribute)
-    }, {})
+    .reduce((attributes, attribute) => mergeAttributes(attributes, attribute), {})
 }

package/src/helpers/getSchema.ts

@@ -1,137 +1,11 @@
-import { NodeSpec, MarkSpec, Schema } from 'prosemirror-model'
-import { Extensions } from '../types'
-import { ExtensionConfig, NodeConfig, MarkConfig } from '..'
-import splitExtensions from './splitExtensions'
-import getAttributesFromExtensions from './getAttributesFromExtensions'
-import getRenderedAttributes from './getRenderedAttributes'
-import isEmptyObject from '../utilities/isEmptyObject'
-import injectExtensionAttributesToParseRule from './injectExtensionAttributesToParseRule'
-import callOrReturn from '../utilities/callOrReturn'
-
-function cleanUpSchemaItem<T>(data: T) {
-  return Object.fromEntries(Object.entries(data).filter(([key, value]) => {
-    if (key === 'attrs' && isEmptyObject(value)) {
-      return false
-    }
-
-    return value !== null && value !== undefined
-  })) as T
-}
-
-export default function getSchema(extensions: Extensions): Schema {
-  const allAttributes = getAttributesFromExtensions(extensions)
-  const { nodeExtensions, markExtensions } = splitExtensions(extensions)
-  const topNode = nodeExtensions.find(extension => extension.config.topNode)?.config.name
-  const nodeSchemaExtenders: (
-    | ExtensionConfig['extendNodeSchema']
-    | NodeConfig['extendNodeSchema']
-    | MarkConfig['extendNodeSchema']
-  )[] = []
-  const markSchemaExtenders: (
-    | ExtensionConfig['extendNodeSchema']
-    | NodeConfig['extendNodeSchema']
-    | MarkConfig['extendNodeSchema']
-  )[] = []
-
-  extensions.forEach(extension => {
-    if (typeof extension.config.extendNodeSchema === 'function') {
-      nodeSchemaExtenders.push(extension.config.extendNodeSchema)
-    }
-
-    if (typeof extension.config.extendMarkSchema === 'function') {
-      markSchemaExtenders.push(extension.config.extendMarkSchema)
-    }
-  })
-
-  const nodes = Object.fromEntries(nodeExtensions.map(extension => {
-    const extensionAttributes = allAttributes.filter(attribute => attribute.type === extension.config.name)
-    const context = { options: extension.options }
-
-    const extraNodeFields = nodeSchemaExtenders.reduce((fields, nodeSchemaExtender) => {
-      const extraFields = callOrReturn(nodeSchemaExtender, context, extension)
-
-      return {
-        ...fields,
-        ...extraFields,
-      }
-    }, {})
+import { Schema } from '@tiptap/pm/model'
 
-    const schema: NodeSpec = cleanUpSchemaItem({
-      ...extraNodeFields,
-      content: callOrReturn(extension.config.content, context),
-      marks: callOrReturn(extension.config.marks, context),
-      group: callOrReturn(extension.config.group, context),
-      inline: callOrReturn(extension.config.inline, context),
-      atom: callOrReturn(extension.config.atom, context),
-      selectable: callOrReturn(extension.config.selectable, context),
-      draggable: callOrReturn(extension.config.draggable, context),
-      code: callOrReturn(extension.config.code, context),
-      defining: callOrReturn(extension.config.defining, context),
-      isolating: callOrReturn(extension.config.isolating, context),
-      attrs: Object.fromEntries(extensionAttributes.map(extensionAttribute => {
-        return [extensionAttribute.name, { default: extensionAttribute?.attribute?.default }]
-      })),
-    })
-
-    if (extension.config.parseHTML) {
-      schema.parseDOM = extension.config.parseHTML
-        .bind(context)()
-        ?.map(parseRule => injectExtensionAttributesToParseRule(parseRule, extensionAttributes))
-    }
-
-    if (extension.config.renderHTML) {
-      schema.toDOM = node => (extension.config.renderHTML as Function)?.bind(context)({
-        node,
-        HTMLAttributes: getRenderedAttributes(node, extensionAttributes),
-      })
-    }
-
-    return [extension.config.name, schema]
-  }))
-
-  const marks = Object.fromEntries(markExtensions.map(extension => {
-    const extensionAttributes = allAttributes.filter(attribute => attribute.type === extension.config.name)
-    const context = { options: extension.options }
-
-    const extraMarkFields = markSchemaExtenders.reduce((fields, markSchemaExtender) => {
-      const extraFields = callOrReturn(markSchemaExtender, context, extension)
-
-      return {
-        ...fields,
-        ...extraFields,
-      }
-    }, {})
-
-    const schema: MarkSpec = cleanUpSchemaItem({
-      ...extraMarkFields,
-      inclusive: callOrReturn(extension.config.inclusive, context),
-      excludes: callOrReturn(extension.config.excludes, context),
-      group: callOrReturn(extension.config.group, context),
-      spanning: callOrReturn(extension.config.spanning, context),
-      attrs: Object.fromEntries(extensionAttributes.map(extensionAttribute => {
-        return [extensionAttribute.name, { default: extensionAttribute?.attribute?.default }]
-      })),
-    })
-
-    if (extension.config.parseHTML) {
-      schema.parseDOM = extension.config.parseHTML
-        .bind(context)()
-        ?.map(parseRule => injectExtensionAttributesToParseRule(parseRule, extensionAttributes))
-    }
-
-    if (extension.config.renderHTML) {
-      schema.toDOM = mark => (extension.config.renderHTML as Function)?.bind(context)({
-        mark,
-        HTMLAttributes: getRenderedAttributes(mark, extensionAttributes),
-      })
-    }
+import { ExtensionManager } from '../ExtensionManager'
+import { Extensions } from '../types'
+import { getSchemaByResolvedExtensions } from './getSchemaByResolvedExtensions'
 
-    return [extension.config.name, schema]
-  }))
+export function getSchema(extensions: Extensions): Schema {
+  const resolvedExtensions = ExtensionManager.resolve(extensions)
 
-  return new Schema({
-    topNode,
-    nodes,
-    marks,
-  })
+  return getSchemaByResolvedExtensions(resolvedExtensions)
 }

package/src/helpers/getSchemaByResolvedExtensions.ts

@@ -0,0 +1,192 @@
+import { MarkSpec, NodeSpec, Schema } from '@tiptap/pm/model'
+
+import { MarkConfig, NodeConfig } from '..'
+import { AnyConfig, Extensions } from '../types'
+import { callOrReturn } from '../utilities/callOrReturn'
+import { isEmptyObject } from '../utilities/isEmptyObject'
+import { getAttributesFromExtensions } from './getAttributesFromExtensions'
+import { getExtensionField } from './getExtensionField'
+import { getRenderedAttributes } from './getRenderedAttributes'
+import { injectExtensionAttributesToParseRule } from './injectExtensionAttributesToParseRule'
+import { splitExtensions } from './splitExtensions'
+
+function cleanUpSchemaItem<T>(data: T) {
+  return Object.fromEntries(
+    Object.entries(data).filter(([key, value]) => {
+      if (key === 'attrs' && isEmptyObject(value)) {
+        return false
+      }
+
+      return value !== null && value !== undefined
+    }),
+  ) as T
+}
+
+export function getSchemaByResolvedExtensions(extensions: Extensions): Schema {
+  const allAttributes = getAttributesFromExtensions(extensions)
+  const { nodeExtensions, markExtensions } = splitExtensions(extensions)
+  const topNode = nodeExtensions.find(extension => getExtensionField(extension, 'topNode'))?.name
+
+  const nodes = Object.fromEntries(
+    nodeExtensions.map(extension => {
+      const extensionAttributes = allAttributes.filter(
+        attribute => attribute.type === extension.name,
+      )
+      const context = {
+        name: extension.name,
+        options: extension.options,
+        storage: extension.storage,
+      }
+
+      const extraNodeFields = extensions.reduce((fields, e) => {
+        const extendNodeSchema = getExtensionField<AnyConfig['extendNodeSchema']>(
+          e,
+          'extendNodeSchema',
+          context,
+        )
+
+        return {
+          ...fields,
+          ...(extendNodeSchema ? extendNodeSchema(extension) : {}),
+        }
+      }, {})
+
+      const schema: NodeSpec = cleanUpSchemaItem({
+        ...extraNodeFields,
+        content: callOrReturn(
+          getExtensionField<NodeConfig['content']>(extension, 'content', context),
+        ),
+        marks: callOrReturn(getExtensionField<NodeConfig['marks']>(extension, 'marks', context)),
+        group: callOrReturn(getExtensionField<NodeConfig['group']>(extension, 'group', context)),
+        inline: callOrReturn(getExtensionField<NodeConfig['inline']>(extension, 'inline', context)),
+        atom: callOrReturn(getExtensionField<NodeConfig['atom']>(extension, 'atom', context)),
+        selectable: callOrReturn(
+          getExtensionField<NodeConfig['selectable']>(extension, 'selectable', context),
+        ),
+        draggable: callOrReturn(
+          getExtensionField<NodeConfig['draggable']>(extension, 'draggable', context),
+        ),
+        code: callOrReturn(getExtensionField<NodeConfig['code']>(extension, 'code', context)),
+        defining: callOrReturn(
+          getExtensionField<NodeConfig['defining']>(extension, 'defining', context),
+        ),
+        isolating: callOrReturn(
+          getExtensionField<NodeConfig['isolating']>(extension, 'isolating', context),
+        ),
+        attrs: Object.fromEntries(
+          extensionAttributes.map(extensionAttribute => {
+            return [extensionAttribute.name, { default: extensionAttribute?.attribute?.default }]
+          }),
+        ),
+      })
+
+      const parseHTML = callOrReturn(
+        getExtensionField<NodeConfig['parseHTML']>(extension, 'parseHTML', context),
+      )
+
+      if (parseHTML) {
+        schema.parseDOM = parseHTML.map(parseRule => injectExtensionAttributesToParseRule(parseRule, extensionAttributes))
+      }
+
+      const renderHTML = getExtensionField<NodeConfig['renderHTML']>(
+        extension,
+        'renderHTML',
+        context,
+      )
+
+      if (renderHTML) {
+        schema.toDOM = node => renderHTML({
+          node,
+          HTMLAttributes: getRenderedAttributes(node, extensionAttributes),
+        })
+      }
+
+      const renderText = getExtensionField<NodeConfig['renderText']>(
+        extension,
+        'renderText',
+        context,
+      )
+
+      if (renderText) {
+        schema.toText = renderText
+      }
+
+      return [extension.name, schema]
+    }),
+  )
+
+  const marks = Object.fromEntries(
+    markExtensions.map(extension => {
+      const extensionAttributes = allAttributes.filter(
+        attribute => attribute.type === extension.name,
+      )
+      const context = {
+        name: extension.name,
+        options: extension.options,
+        storage: extension.storage,
+      }
+
+      const extraMarkFields = extensions.reduce((fields, e) => {
+        const extendMarkSchema = getExtensionField<AnyConfig['extendMarkSchema']>(
+          e,
+          'extendMarkSchema',
+          context,
+        )
+
+        return {
+          ...fields,
+          ...(extendMarkSchema ? extendMarkSchema(extension) : {}),
+        }
+      }, {})
+
+      const schema: MarkSpec = cleanUpSchemaItem({
+        ...extraMarkFields,
+        inclusive: callOrReturn(
+          getExtensionField<MarkConfig['inclusive']>(extension, 'inclusive', context),
+        ),
+        excludes: callOrReturn(
+          getExtensionField<MarkConfig['excludes']>(extension, 'excludes', context),
+        ),
+        group: callOrReturn(getExtensionField<MarkConfig['group']>(extension, 'group', context)),
+        spanning: callOrReturn(
+          getExtensionField<MarkConfig['spanning']>(extension, 'spanning', context),
+        ),
+        code: callOrReturn(getExtensionField<MarkConfig['code']>(extension, 'code', context)),
+        attrs: Object.fromEntries(
+          extensionAttributes.map(extensionAttribute => {
+            return [extensionAttribute.name, { default: extensionAttribute?.attribute?.default }]
+          }),
+        ),
+      })
+
+      const parseHTML = callOrReturn(
+        getExtensionField<MarkConfig['parseHTML']>(extension, 'parseHTML', context),
+      )
+
+      if (parseHTML) {
+        schema.parseDOM = parseHTML.map(parseRule => injectExtensionAttributesToParseRule(parseRule, extensionAttributes))
+      }
+
+      const renderHTML = getExtensionField<MarkConfig['renderHTML']>(
+        extension,
+        'renderHTML',
+        context,
+      )
+
+      if (renderHTML) {
+        schema.toDOM = mark => renderHTML({
+          mark,
+          HTMLAttributes: getRenderedAttributes(mark, extensionAttributes),
+        })
+      }
+
+      return [extension.name, schema]
+    }),
+  )
+
+  return new Schema({
+    topNode,
+    nodes,
+    marks,
+  })
+}

package/src/helpers/getSchemaTypeByName.ts

@@ -1,13 +1,5 @@
-import { MarkType, NodeType, Schema } from 'prosemirror-model'
+import { MarkType, NodeType, Schema } from '@tiptap/pm/model'
 
-export default function getSchemaTypeByName(name: string, schema: Schema): NodeType | MarkType | null {
-  if (schema.nodes[name]) {
-    return schema.nodes[name]
-  }
-
-  if (schema.marks[name]) {
-    return schema.marks[name]
-  }
-
-  return null
+export function getSchemaTypeByName(name: string, schema: Schema): NodeType | MarkType | null {
+  return schema.nodes[name] || schema.marks[name] || null
 }

package/src/helpers/getSchemaTypeNameByName.ts

@@ -1,6 +1,6 @@
-import { Schema } from 'prosemirror-model'
+import { Schema } from '@tiptap/pm/model'
 
-export default function getSchemaTypeNameByName(name: string, schema: Schema): 'node' | 'mark' | null {
+export function getSchemaTypeNameByName(name: string, schema: Schema): 'node' | 'mark' | null {
   if (schema.nodes[name]) {
     return 'node'
   }

package/src/helpers/getSplittedAttributes.ts

@@ -1,10 +1,10 @@
-import { AnyObject, ExtensionAttribute } from '../types'
+import { ExtensionAttribute } from '../types'
 
-export default function getSplittedAttributes(
+export function getSplittedAttributes(
   extensionAttributes: ExtensionAttribute[],
   typeName: string,
-  attributes: AnyObject,
-): AnyObject {
+  attributes: Record<string, any>,
+): Record<string, any> {
   return Object.fromEntries(Object
     .entries(attributes)
     .filter(([name]) => {

package/src/helpers/getText.ts

@@ -0,0 +1,19 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+
+import { TextSerializer } from '../types'
+import { getTextBetween } from './getTextBetween'
+
+export function getText(
+  node: ProseMirrorNode,
+  options?: {
+    blockSeparator?: string
+    textSerializers?: Record<string, TextSerializer>
+  },
+) {
+  const range = {
+    from: 0,
+    to: node.content.size,
+  }
+
+  return getTextBetween(node, range, options)
+}

package/src/helpers/getTextBetween.ts

@@ -0,0 +1,46 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+
+import { Range, TextSerializer } from '../types'
+
+export function getTextBetween(
+  startNode: ProseMirrorNode,
+  range: Range,
+  options?: {
+    blockSeparator?: string
+    textSerializers?: Record<string, TextSerializer>
+  },
+): string {
+  const { from, to } = range
+  const { blockSeparator = '\n\n', textSerializers = {} } = options || {}
+  let text = ''
+  let separated = true
+
+  startNode.nodesBetween(from, to, (node, pos, parent, index) => {
+    const textSerializer = textSerializers?.[node.type.name]
+
+    if (textSerializer) {
+      if (node.isBlock && !separated) {
+        text += blockSeparator
+        separated = true
+      }
+
+      if (parent) {
+        text += textSerializer({
+          node,
+          pos,
+          parent,
+          index,
+          range,
+        })
+      }
+    } else if (node.isText) {
+      text += node?.text?.slice(Math.max(from, pos) - pos, to - pos) // eslint-disable-line
+      separated = false
+    } else if (node.isBlock && !separated) {
+      text += blockSeparator
+      separated = true
+    }
+  })
+
+  return text
+}