@tiptap/core 3.0.0 → 3.0.2

package/src/helpers/flattenExtensions.ts

@@ -0,0 +1,30 @@
+import type { AnyConfig, Extensions } from '../types.js'
+import { getExtensionField } from './getExtensionField.js'
+
+/**
+ * Create a flattened array of extensions by traversing the `addExtensions` field.
+ * @param extensions An array of Tiptap extensions
+ * @returns A flattened array of Tiptap extensions
+ */
+export function flattenExtensions(extensions: Extensions): Extensions {
+  return (
+    extensions
+      .map(extension => {
+        const context = {
+          name: extension.name,
+          options: extension.options,
+          storage: extension.storage,
+        }
+
+        const addExtensions = getExtensionField<AnyConfig['addExtensions']>(extension, 'addExtensions', context)
+
+        if (addExtensions) {
+          return [extension, ...flattenExtensions(addExtensions())]
+        }
+
+        return extension
+      })
+      // `Infinity` will break TypeScript so we set a number that is probably high enough
+      .flat(10)
+  )
+}

package/src/helpers/generateHTML.ts

@@ -1,6 +1,6 @@
 import { Node } from '@tiptap/pm/model'
 
-import { Extensions, JSONContent } from '../types.js'
+import type { Extensions, JSONContent } from '../types.js'
 import { getHTMLFromFragment } from './getHTMLFromFragment.js'
 import { getSchema } from './getSchema.js'
 

package/src/helpers/generateJSON.ts

@@ -1,6 +1,6 @@
 import { DOMParser } from '@tiptap/pm/model'
 
-import { Extensions } from '../types.js'
+import type { Extensions } from '../types.js'
 import { elementFromString } from '../utilities/elementFromString.js'
 import { getSchema } from './getSchema.js'
 

package/src/helpers/generateText.ts

@@ -1,6 +1,6 @@
 import { Node } from '@tiptap/pm/model'
 
-import { Extensions, JSONContent, TextSerializer } from '../types.js'
+import type { Extensions, JSONContent, TextSerializer } from '../types.js'
 import { getSchema } from './getSchema.js'
 import { getText } from './getText.js'
 import { getTextSerializersFromSchema } from './getTextSerializersFromSchema.js'

package/src/helpers/getAttributes.ts

@@ -1,5 +1,5 @@
-import { MarkType, NodeType } from '@tiptap/pm/model'
-import { EditorState } from '@tiptap/pm/state'
+import type { MarkType, NodeType } from '@tiptap/pm/model'
+import type { EditorState } from '@tiptap/pm/state'
 
 import { getMarkAttributes } from './getMarkAttributes.js'
 import { getNodeAttributes } from './getNodeAttributes.js'
@@ -11,10 +11,7 @@ import { getSchemaTypeNameByName } from './getSchemaTypeNameByName.js'
  * @param typeOrName The node or mark type or name
  * @returns The attributes of the node or mark or an empty object
  */
-export function getAttributes(
-  state: EditorState,
-  typeOrName: string | NodeType | MarkType,
-): Record<string, any> {
+export function getAttributes(state: EditorState, typeOrName: string | NodeType | MarkType): Record<string, any> {
   const schemaType = getSchemaTypeNameByName(
     typeof typeOrName === 'string' ? typeOrName : typeOrName.name,
     state.schema,

package/src/helpers/getAttributesFromExtensions.ts

@@ -1,11 +1,5 @@
-import { MarkConfig, NodeConfig } from '../index.js'
-import {
-  AnyConfig,
-  Attribute,
-  Attributes,
-  ExtensionAttribute,
-  Extensions,
-} from '../types.js'
+import type { MarkConfig, NodeConfig } from '../index.js'
+import type { AnyConfig, Attribute, Attributes, ExtensionAttribute, Extensions } from '../types.js'
 import { getExtensionField } from './getExtensionField.js'
 import { splitExtensions } from './splitExtensions.js'
 
@@ -17,8 +11,9 @@ export function getAttributesFromExtensions(extensions: Extensions): ExtensionAt
   const extensionAttributes: ExtensionAttribute[] = []
   const { nodeExtensions, markExtensions } = splitExtensions(extensions)
   const nodeAndMarkExtensions = [...nodeExtensions, ...markExtensions]
-  const defaultAttribute: Required<Attribute> = {
+  const defaultAttribute: Required<Omit<Attribute, 'validate'>> & Pick<Attribute, 'validate'> = {
     default: null,
+    validate: undefined,
     rendered: true,
     renderHTML: null,
     parseHTML: null,
@@ -48,18 +43,16 @@ export function getAttributesFromExtensions(extensions: Extensions): ExtensionAt
 
     globalAttributes.forEach(globalAttribute => {
       globalAttribute.types.forEach(type => {
-        Object
-          .entries(globalAttribute.attributes)
-          .forEach(([name, attribute]) => {
-            extensionAttributes.push({
-              type,
-              name,
-              attribute: {
-                ...defaultAttribute,
-                ...attribute,
-              },
-            })
+        Object.entries(globalAttribute.attributes).forEach(([name, attribute]) => {
+          extensionAttributes.push({
+            type,
+            name,
+            attribute: {
+              ...defaultAttribute,
+              ...attribute,
+            },
           })
+        })
       })
     })
   })
@@ -84,28 +77,26 @@ export function getAttributesFromExtensions(extensions: Extensions): ExtensionAt
     // TODO: remove `as Attributes`
     const attributes = addAttributes() as Attributes
 
-    Object
-      .entries(attributes)
-      .forEach(([name, attribute]) => {
-        const mergedAttr = {
-          ...defaultAttribute,
-          ...attribute,
-        }
+    Object.entries(attributes).forEach(([name, attribute]) => {
+      const mergedAttr = {
+        ...defaultAttribute,
+        ...attribute,
+      }
 
-        if (typeof mergedAttr?.default === 'function') {
-          mergedAttr.default = mergedAttr.default()
-        }
+      if (typeof mergedAttr?.default === 'function') {
+        mergedAttr.default = mergedAttr.default()
+      }
 
-        if (mergedAttr?.isRequired && mergedAttr?.default === undefined) {
-          delete mergedAttr.default
-        }
+      if (mergedAttr?.isRequired && mergedAttr?.default === undefined) {
+        delete mergedAttr.default
+      }
 
-        extensionAttributes.push({
-          type: extension.name,
-          name,
-          attribute: mergedAttr,
-        })
+      extensionAttributes.push({
+        type: extension.name,
+        name,
+        attribute: mergedAttr,
       })
+    })
   })
 
   return extensionAttributes

package/src/helpers/getChangedRanges.ts

@@ -1,11 +1,11 @@
-import { Step, Transform } from '@tiptap/pm/transform'
+import type { Step, Transform } from '@tiptap/pm/transform'
 
-import { Range } from '../types.js'
+import type { Range } from '../types.js'
 import { removeDuplicates } from '../utilities/removeDuplicates.js'
 
 export type ChangedRange = {
-  oldRange: Range,
-  newRange: Range,
+  oldRange: Range
+  newRange: Range
 }
 
 /**
@@ -18,15 +18,17 @@ function simplifyChangedRanges(changes: ChangedRange[]): ChangedRange[] {
   return uniqueChanges.length === 1
     ? uniqueChanges
     : uniqueChanges.filter((change, index) => {
-      const rest = uniqueChanges.filter((_, i) => i !== index)
+        const rest = uniqueChanges.filter((_, i) => i !== index)
 
-      return !rest.some(otherChange => {
-        return change.oldRange.from >= otherChange.oldRange.from
-          && change.oldRange.to <= otherChange.oldRange.to
-          && change.newRange.from >= otherChange.newRange.from
-          && change.newRange.to <= otherChange.newRange.to
+        return !rest.some(otherChange => {
+          return (
+            change.oldRange.from >= otherChange.oldRange.from &&
+            change.oldRange.to <= otherChange.oldRange.to &&
+            change.newRange.from >= otherChange.newRange.from &&
+            change.newRange.to <= otherChange.newRange.to
+          )
+        })
       })
-    })
 }
 
 /**
@@ -45,8 +47,8 @@ export function getChangedRanges(transform: Transform): ChangedRange[] {
     // @ts-ignore
     if (!stepMap.ranges.length) {
       const { from, to } = steps[index] as Step & {
-        from?: number,
-        to?: number,
+        from?: number
+        to?: number
       }
 
       if (from === undefined || to === undefined) {

package/src/helpers/getDebugJSON.ts

@@ -1,6 +1,6 @@
-import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+import type { Node as ProseMirrorNode } from '@tiptap/pm/model'
 
-import { JSONContent } from '../types.js'
+import type { JSONContent } from '../types.js'
 
 interface DebugJSONContent extends JSONContent {
   from: number

package/src/helpers/getExtensionField.ts

@@ -1,4 +1,7 @@
-import { AnyExtension, MaybeThisParameterType, RemoveThis } from '../types.js'
+import type { ExtensionConfig } from '../Extension.js'
+import type { MarkConfig } from '../Mark.js'
+import type { NodeConfig } from '../Node.js'
+import type { AnyExtension, MaybeThisParameterType, RemoveThis } from '../types.js'
 
 /**
  * Returns a field from an extension
@@ -7,26 +10,23 @@ import { AnyExtension, MaybeThisParameterType, RemoveThis } from '../types.js'
  * @param context The context object that should be passed as `this` into the function
  * @returns The field value
  */
-export function getExtensionField<T = any>(
-  extension: AnyExtension,
-  field: string,
+export function getExtensionField<T = any, E extends AnyExtension = any>(
+  extension: E,
+  field: keyof ExtensionConfig | keyof MarkConfig | keyof NodeConfig,
   context?: Omit<MaybeThisParameterType<T>, 'parent'>,
 ): RemoveThis<T> {
-
-  if (extension.config[field] === undefined && extension.parent) {
+  if (extension.config[field as keyof typeof extension.config] === undefined && extension.parent) {
     return getExtensionField(extension.parent, field, context)
   }
 
-  if (typeof extension.config[field] === 'function') {
-    const value = extension.config[field].bind({
+  if (typeof extension.config[field as keyof typeof extension.config] === 'function') {
+    const value = (extension.config[field as keyof typeof extension.config] as any).bind({
       ...context,
-      parent: extension.parent
-        ? getExtensionField(extension.parent, field, context)
-        : null,
+      parent: extension.parent ? getExtensionField(extension.parent, field, context) : null,
     })
 
     return value
   }
 
-  return extension.config[field]
+  return extension.config[field as keyof typeof extension.config] as RemoveThis<T>
 }

package/src/helpers/getHTMLFromFragment.ts

@@ -1,4 +1,5 @@
-import { DOMSerializer, Fragment, Schema } from '@tiptap/pm/model'
+import type { Fragment, Schema } from '@tiptap/pm/model'
+import { DOMSerializer } from '@tiptap/pm/model'
 
 export function getHTMLFromFragment(fragment: Fragment, schema: Schema): string {
   const documentFragment = DOMSerializer.fromSchema(schema).serializeFragment(fragment)

package/src/helpers/getMarkAttributes.ts

@@ -1,12 +1,9 @@
-import { Mark, MarkType } from '@tiptap/pm/model'
-import { EditorState } from '@tiptap/pm/state'
+import type { Mark, MarkType } from '@tiptap/pm/model'
+import type { EditorState } from '@tiptap/pm/state'
 
 import { getMarkType } from './getMarkType.js'
 
-export function getMarkAttributes(
-  state: EditorState,
-  typeOrName: string | MarkType,
-): Record<string, any> {
+export function getMarkAttributes(state: EditorState, typeOrName: string | MarkType): Record<string, any> {
   const type = getMarkType(typeOrName, state.schema)
   const { from, to, empty } = state.selection
   const marks: Mark[] = []

package/src/helpers/getMarkRange.ts

@@ -1,6 +1,6 @@
-import { Mark as ProseMirrorMark, MarkType, ResolvedPos } from '@tiptap/pm/model'
+import type { Mark as ProseMirrorMark, MarkType, ResolvedPos } from '@tiptap/pm/model'
 
-import { Range } from '../types.js'
+import type { Range } from '../types.js'
 import { objectIncludes } from '../utilities/objectIncludes.js'
 
 function findMarkInSet(
@@ -9,37 +9,59 @@ function findMarkInSet(
   attributes: Record<string, any> = {},
 ): ProseMirrorMark | undefined {
   return marks.find(item => {
-    return item.type === type && objectIncludes(item.attrs, attributes)
+    return (
+      item.type === type &&
+      objectIncludes(
+        // Only check equality for the attributes that are provided
+        Object.fromEntries(Object.keys(attributes).map(k => [k, item.attrs[k]])),
+        attributes,
+      )
+    )
   })
 }
 
-function isMarkInSet(
-  marks: ProseMirrorMark[],
-  type: MarkType,
-  attributes: Record<string, any> = {},
-): boolean {
+function isMarkInSet(marks: ProseMirrorMark[], type: MarkType, attributes: Record<string, any> = {}): boolean {
   return !!findMarkInSet(marks, type, attributes)
 }
 
+/**
+ * Get the range of a mark at a resolved position.
+ */
 export function getMarkRange(
+  /**
+   * The position to get the mark range for.
+   */
   $pos: ResolvedPos,
+  /**
+   * The mark type to get the range for.
+   */
   type: MarkType,
-  attributes: Record<string, any> = {},
+  /**
+   * The attributes to match against.
+   * If not provided, only the first mark at the position will be matched.
+   */
+  attributes?: Record<string, any>,
 ): Range | void {
   if (!$pos || !type) {
     return
   }
-
   let start = $pos.parent.childAfter($pos.parentOffset)
 
-  if ($pos.parentOffset === start.offset && start.offset !== 0) {
+  // If the cursor is at the start of a text node that does not have the mark, look backward
+  if (!start.node || !start.node.marks.some(mark => mark.type === type)) {
     start = $pos.parent.childBefore($pos.parentOffset)
   }
 
-  if (!start.node) {
+  // If there is no text node with the mark even backward, return undefined
+  if (!start.node || !start.node.marks.some(mark => mark.type === type)) {
     return
   }
 
+  // Default to only matching against the first mark's attributes
+  attributes = attributes || start.node.marks[0]?.attrs
+
+  // We now know that the cursor is either at the start, middle or end of a text node with the specified mark
+  // so we can look it up on the targeted mark
   const mark = findMarkInSet([...start.node.marks], type, attributes)
 
   if (!mark) {
@@ -51,17 +73,12 @@ export function getMarkRange(
   let endIndex = startIndex + 1
   let endPos = startPos + start.node.nodeSize
 
-  findMarkInSet([...start.node.marks], type, attributes)
-
-  while (startIndex > 0 && mark.isInSet($pos.parent.child(startIndex - 1).marks)) {
+  while (startIndex > 0 && isMarkInSet([...$pos.parent.child(startIndex - 1).marks], type, attributes)) {
     startIndex -= 1
     startPos -= $pos.parent.child(startIndex).nodeSize
   }
 
-  while (
-    endIndex < $pos.parent.childCount
-    && isMarkInSet([...$pos.parent.child(endIndex).marks], type, attributes)
-  ) {
+  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,11 +1,9 @@
-import { MarkType, Schema } from '@tiptap/pm/model'
+import type { MarkType, Schema } from '@tiptap/pm/model'
 
 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?`,
-      )
+      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,6 +1,6 @@
-import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+import type { Node as ProseMirrorNode } from '@tiptap/pm/model'
 
-import { MarkRange } from '../types.js'
+import type { MarkRange } from '../types.js'
 import { getMarkRange } from './getMarkRange.js'
 
 export function getMarksBetween(from: number, to: number, doc: ProseMirrorNode): MarkRange[] {
@@ -12,7 +12,7 @@ export function getMarksBetween(from: number, to: number, doc: ProseMirrorNode):
       .resolve(from)
       .marks()
       .forEach(mark => {
-        const $pos = doc.resolve(from - 1)
+        const $pos = doc.resolve(from)
         const range = getMarkRange($pos, mark.type)
 
         if (!range) {

package/src/helpers/getNodeAtPosition.ts

@@ -1,5 +1,5 @@
-import { Node, NodeType } from '@tiptap/pm/model'
-import { EditorState } from '@tiptap/pm/state'
+import type { Node, NodeType } from '@tiptap/pm/model'
+import type { EditorState } from '@tiptap/pm/state'
 
 /**
  * Finds the first node of a given type or name in the current selection.

package/src/helpers/getNodeAttributes.ts

@@ -1,12 +1,9 @@
-import { Node, NodeType } from '@tiptap/pm/model'
-import { EditorState } from '@tiptap/pm/state'
+import type { Node, NodeType } from '@tiptap/pm/model'
+import type { EditorState } from '@tiptap/pm/state'
 
 import { getNodeType } from './getNodeType.js'
 
-export function getNodeAttributes(
-  state: EditorState,
-  typeOrName: string | NodeType,
-): Record<string, any> {
+export function getNodeAttributes(state: EditorState, typeOrName: string | NodeType): Record<string, any> {
   const type = getNodeType(typeOrName, state.schema)
   const { from, to } = state.selection
   const nodes: Node[] = []

package/src/helpers/getNodeType.ts

@@ -1,11 +1,9 @@
-import { NodeType, Schema } from '@tiptap/pm/model'
+import type { NodeType, Schema } from '@tiptap/pm/model'
 
 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?`,
-      )
+      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,6 +1,6 @@
-import { Mark, Node } from '@tiptap/pm/model'
+import type { Mark, Node } from '@tiptap/pm/model'
 
-import { ExtensionAttribute } from '../types.js'
+import type { ExtensionAttribute } from '../types.js'
 import { mergeAttributes } from '../utilities/mergeAttributes.js'
 
 export function getRenderedAttributes(
@@ -8,6 +8,7 @@ export function getRenderedAttributes(
   extensionAttributes: ExtensionAttribute[],
 ): Record<string, any> {
   return extensionAttributes
+    .filter(attribute => attribute.type === nodeOrMark.type.name)
     .filter(item => item.attribute.rendered)
     .map(item => {
       if (!item.attribute.renderHTML) {

package/src/helpers/getSchema.ts

@@ -1,12 +1,12 @@
-import { Schema } from '@tiptap/pm/model'
+import type { Schema } from '@tiptap/pm/model'
 
-import { Editor } from '../Editor.js'
-import { ExtensionManager } from '../ExtensionManager.js'
-import { Extensions } from '../types.js'
+import type { Editor } from '../Editor.js'
+import type { Extensions } from '../types.js'
 import { getSchemaByResolvedExtensions } from './getSchemaByResolvedExtensions.js'
+import { resolveExtensions } from './resolveExtensions.js'
 
 export function getSchema(extensions: Extensions, editor?: Editor): Schema {
-  const resolvedExtensions = ExtensionManager.resolve(extensions)
+  const resolvedExtensions = resolveExtensions(extensions)
 
   return getSchemaByResolvedExtensions(resolvedExtensions, editor)
 }