@tiptap/core 2.0.0-beta.22 → 2.0.0-beta.220

package/src/extensions/keymap.ts

@@ -1,4 +1,10 @@
+import { Plugin, PluginKey, Selection } from '@tiptap/pm/state'
+
+import { CommandManager } from '../CommandManager'
 import { Extension } from '../Extension'
+import { createChainableState } from '../helpers/createChainableState'
+import { isiOS } from '../utilities/isiOS'
+import { isMacOS } from '../utilities/isMacOS'
 
 export const Keymap = Extension.create({
   name: 'keymap',
@@ -6,6 +12,19 @@ export const Keymap = Extension.create({
   addKeyboardShortcuts() {
     const handleBackspace = () => this.editor.commands.first(({ commands }) => [
       () => commands.undoInputRule(),
+      // maybe convert first text block node to default node
+      () => commands.command(({ tr }) => {
+        const { selection, doc } = tr
+        const { empty, $anchor } = selection
+        const { pos, parent } = $anchor
+        const isAtStart = Selection.atStart(doc).from === pos
+
+        if (!empty || !isAtStart || !parent.type.isTextblock || parent.textContent.length) {
+          return false
+        }
+
+        return commands.clearNodes()
+      }),
       () => commands.deleteSelection(),
       () => commands.joinBackward(),
       () => commands.selectNodeBackward(),
@@ -13,24 +32,98 @@ export const Keymap = Extension.create({
 
     const handleDelete = () => this.editor.commands.first(({ commands }) => [
       () => commands.deleteSelection(),
+      () => commands.deleteCurrentNode(),
       () => commands.joinForward(),
       () => commands.selectNodeForward(),
     ])
 
-    return {
-      Enter: () => this.editor.commands.first(({ commands }) => [
-        () => commands.newlineInCode(),
-        () => commands.createParagraphNear(),
-        () => commands.liftEmptyBlock(),
-        () => commands.splitBlock(),
-      ]),
+    const handleEnter = () => this.editor.commands.first(({ commands }) => [
+      () => commands.newlineInCode(),
+      () => commands.createParagraphNear(),
+      () => commands.liftEmptyBlock(),
+      () => commands.splitBlock(),
+    ])
+
+    const baseKeymap = {
+      Enter: handleEnter,
       'Mod-Enter': () => this.editor.commands.exitCode(),
-      Backspace: () => handleBackspace(),
-      'Mod-Backspace': () => handleBackspace(),
-      Delete: () => handleDelete(),
-      'Mod-Delete': () => handleDelete(),
-      // we don’t need a custom `selectAll` for now
-      // 'Mod-a': () => this.editor.commands.selectAll(),
+      Backspace: handleBackspace,
+      'Mod-Backspace': handleBackspace,
+      'Shift-Backspace': handleBackspace,
+      Delete: handleDelete,
+      'Mod-Delete': handleDelete,
+      'Mod-a': () => this.editor.commands.selectAll(),
+    }
+
+    const pcKeymap = {
+      ...baseKeymap,
+    }
+
+    const macKeymap = {
+      ...baseKeymap,
+      'Ctrl-h': handleBackspace,
+      'Alt-Backspace': handleBackspace,
+      'Ctrl-d': handleDelete,
+      'Ctrl-Alt-Backspace': handleDelete,
+      'Alt-Delete': handleDelete,
+      'Alt-d': handleDelete,
+      'Ctrl-a': () => this.editor.commands.selectTextblockStart(),
+      'Ctrl-e': () => this.editor.commands.selectTextblockEnd(),
+    }
+
+    if (isiOS() || isMacOS()) {
+      return macKeymap
     }
+
+    return pcKeymap
+  },
+
+  addProseMirrorPlugins() {
+    return [
+      // With this plugin we check if the whole document was selected and deleted.
+      // In this case we will additionally call `clearNodes()` to convert e.g. a heading
+      // to a paragraph if necessary.
+      // This is an alternative to ProseMirror's `AllSelection`, which doesn’t work well
+      // with many other commands.
+      new Plugin({
+        key: new PluginKey('clearDocument'),
+        appendTransaction: (transactions, oldState, newState) => {
+          const docChanges = transactions.some(transaction => transaction.docChanged)
+            && !oldState.doc.eq(newState.doc)
+
+          if (!docChanges) {
+            return
+          }
+
+          const { empty, from, to } = oldState.selection
+          const allFrom = Selection.atStart(oldState.doc).from
+          const allEnd = Selection.atEnd(oldState.doc).to
+          const allWasSelected = from === allFrom && to === allEnd
+          const isEmpty = newState.doc.textBetween(0, newState.doc.content.size, ' ', ' ').length === 0
+
+          if (empty || !allWasSelected || !isEmpty) {
+            return
+          }
+
+          const tr = newState.tr
+          const state = createChainableState({
+            state: newState,
+            transaction: tr,
+          })
+          const { commands } = new CommandManager({
+            editor: this.editor,
+            state,
+          })
+
+          commands.clearNodes()
+
+          if (!tr.steps.length) {
+            return
+          }
+
+          return tr
+        },
+      }),
+    ]
   },
 })

package/src/extensions/tabindex.ts

@@ -0,0 +1,18 @@
+import { Plugin, PluginKey } from '@tiptap/pm/state'
+
+import { Extension } from '../Extension'
+
+export const Tabindex = Extension.create({
+  name: 'tabindex',
+
+  addProseMirrorPlugins() {
+    return [
+      new Plugin({
+        key: new PluginKey('tabindex'),
+        props: {
+          attributes: this.editor.isEditable ? { tabindex: '0' } : {},
+        },
+      }),
+    ]
+  },
+})

package/src/helpers/combineTransactionSteps.ts

@@ -0,0 +1,21 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+import { Transaction } from '@tiptap/pm/state'
+import { Transform } from '@tiptap/pm/transform'
+
+/**
+ * Returns a new `Transform` based on all steps of the passed transactions.
+ */
+export function combineTransactionSteps(
+  oldDoc: ProseMirrorNode,
+  transactions: Transaction[],
+): Transform {
+  const transform = new Transform(oldDoc)
+
+  transactions.forEach(transaction => {
+    transaction.steps.forEach(step => {
+      transform.step(step)
+    })
+  })
+
+  return transform
+}

package/src/helpers/createChainableState.ts

@@ -0,0 +1,38 @@
+import { EditorState, Transaction } from '@tiptap/pm/state'
+
+export function createChainableState(config: {
+  transaction: Transaction
+  state: EditorState
+}): EditorState {
+  const { state, transaction } = config
+  let { selection } = transaction
+  let { doc } = transaction
+  let { storedMarks } = transaction
+
+  return {
+    ...state,
+    apply: state.apply.bind(state),
+    applyTransaction: state.applyTransaction.bind(state),
+    filterTransaction: state.filterTransaction,
+    plugins: state.plugins,
+    schema: state.schema,
+    reconfigure: state.reconfigure.bind(state),
+    toJSON: state.toJSON.bind(state),
+    get storedMarks() {
+      return storedMarks
+    },
+    get selection() {
+      return selection
+    },
+    get doc() {
+      return doc
+    },
+    get tr() {
+      selection = transaction.selection
+      doc = transaction.doc
+      storedMarks = transaction.storedMarks
+
+      return transaction
+    },
+  }
+}

package/src/helpers/createDocument.ts

@@ -1,13 +1,12 @@
-import { Schema, Node as ProseMirrorNode } from 'prosemirror-model'
-import { AnyObject } from '../types'
-import createNodeFromContent from './createNodeFromContent'
+import { Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model'
 
-export type Content = string | JSON | null
+import { Content } from '../types'
+import { createNodeFromContent } from './createNodeFromContent'
 
-export default function createDocument(
+export function createDocument(
   content: Content,
   schema: Schema,
-  parseOptions: AnyObject = {},
+  parseOptions: ParseOptions = {},
 ): ProseMirrorNode {
   return createNodeFromContent(content, schema, { slice: false, parseOptions }) as ProseMirrorNode
 }

package/src/helpers/createNodeFromContent.ts

@@ -1,58 +1,50 @@
 import {
-  Schema,
   DOMParser,
-  Node as ProseMirrorNode,
   Fragment,
-} from 'prosemirror-model'
-import elementFromString from '../utilities/elementFromString'
-import { AnyObject } from '../types'
+  Node as ProseMirrorNode,
+  ParseOptions,
+  Schema,
+} from '@tiptap/pm/model'
 
-export type Content = string | JSON | null
+import { Content } from '../types'
+import { elementFromString } from '../utilities/elementFromString'
 
 export type CreateNodeFromContentOptions = {
-  slice?: boolean,
-  parseOptions?: AnyObject,
+  slice?: boolean
+  parseOptions?: ParseOptions
 }
 
-export default function createNodeFromContent(
+export function createNodeFromContent(
   content: Content,
   schema: Schema,
   options?: CreateNodeFromContentOptions,
-): string | ProseMirrorNode | Fragment {
+): ProseMirrorNode | Fragment {
   options = {
     slice: true,
     parseOptions: {},
     ...options,
   }
 
-  if (content && typeof content === 'object') {
+  if (typeof content === 'object' && content !== null) {
     try {
+      if (Array.isArray(content) && content.length > 0) {
+        return Fragment.fromArray(content.map(item => schema.nodeFromJSON(item)))
+      }
+
       return schema.nodeFromJSON(content)
     } catch (error) {
-      console.warn(
-        '[tiptap warn]: Invalid content.',
-        'Passed value:',
-        content,
-        'Error:',
-        error,
-      )
+      console.warn('[tiptap warn]: Invalid content.', 'Passed value:', content, 'Error:', error)
 
       return createNodeFromContent('', schema, options)
     }
   }
 
   if (typeof content === 'string') {
-    const isHTML = content.trim().startsWith('<') && content.trim().endsWith('>')
-
-    if (isHTML || !options.slice) {
-      const parser = DOMParser.fromSchema(schema)
-
-      return options.slice
-        ? parser.parseSlice(elementFromString(content), options.parseOptions).content
-        : parser.parse(elementFromString(content), options.parseOptions)
-    }
+    const parser = DOMParser.fromSchema(schema)
 
-    return content
+    return options.slice
+      ? parser.parseSlice(elementFromString(content), options.parseOptions).content
+      : parser.parse(elementFromString(content), options.parseOptions)
   }
 
   return createNodeFromContent('', schema, options)

package/src/helpers/defaultBlockAt.ts

@@ -0,0 +1,13 @@
+import { ContentMatch, NodeType } from '@tiptap/pm/model'
+
+export function defaultBlockAt(match: ContentMatch): NodeType | null {
+  for (let i = 0; i < match.edgeCount; i += 1) {
+    const { type } = match.edge(i)
+
+    if (type.isTextblock && !type.hasRequiredAttrs()) {
+      return type
+    }
+  }
+
+  return null
+}

package/src/helpers/findChildren.ts

@@ -1,12 +1,8 @@
-import { Node as ProseMirrorNode } from 'prosemirror-model'
-import { Predicate } from '../types'
+import { Node as ProseMirrorNode } from '@tiptap/pm/model'
 
-type NodeWithPos = {
-  node: ProseMirrorNode,
-  pos: number,
-}
+import { NodeWithPos, Predicate } from '../types'
 
-export default function findChildren(node: ProseMirrorNode, predicate: Predicate): NodeWithPos[] {
+export function findChildren(node: ProseMirrorNode, predicate: Predicate): NodeWithPos[] {
   const nodesWithPos: NodeWithPos[] = []
 
   node.descendants((child, pos) => {

package/src/helpers/findChildrenInRange.ts

@@ -0,0 +1,36 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+
+import { NodeWithPos, Predicate, Range } from '../types'
+
+/**
+ * Same as `findChildren` but searches only within a `range`.
+ */
+export function findChildrenInRange(
+  node: ProseMirrorNode,
+  range: Range,
+  predicate: Predicate,
+): NodeWithPos[] {
+  const nodesWithPos: NodeWithPos[] = []
+
+  // if (range.from === range.to) {
+  //   const nodeAt = node.nodeAt(range.from)
+
+  //   if (nodeAt) {
+  //     nodesWithPos.push({
+  //       node: nodeAt,
+  //       pos: range.from,
+  //     })
+  //   }
+  // }
+
+  node.nodesBetween(range.from, range.to, (child, pos) => {
+    if (predicate(child)) {
+      nodesWithPos.push({
+        node: child,
+        pos,
+      })
+    }
+  })
+
+  return nodesWithPos
+}

package/src/helpers/findParentNode.ts

@@ -1,7 +1,8 @@
-import { Selection } from 'prosemirror-state'
-import findParentNodeClosestToPos from './findParentNodeClosestToPos'
+import { Selection } from '@tiptap/pm/state'
+
 import { Predicate } from '../types'
+import { findParentNodeClosestToPos } from './findParentNodeClosestToPos'
 
-export default function findParentNode(predicate: Predicate) {
+export function findParentNode(predicate: Predicate) {
   return (selection: Selection) => findParentNodeClosestToPos(selection.$from, predicate)
 }

package/src/helpers/findParentNodeClosestToPos.ts

@@ -1,12 +1,18 @@
-import { ResolvedPos, Node as ProseMirrorNode } from 'prosemirror-model'
+import { Node as ProseMirrorNode, ResolvedPos } from '@tiptap/pm/model'
+
 import { Predicate } from '../types'
 
-export default function findParentNodeClosestToPos($pos: ResolvedPos, predicate: Predicate): ({
-  pos: number,
-  start: number,
-  depth: number,
-  node: ProseMirrorNode,
-} | undefined) {
+export function findParentNodeClosestToPos(
+  $pos: ResolvedPos,
+  predicate: Predicate,
+):
+  | {
+      pos: number
+      start: number
+      depth: number
+      node: ProseMirrorNode
+    }
+  | undefined {
   for (let i = $pos.depth; i > 0; i -= 1) {
     const node = $pos.node(i)
 

package/src/helpers/generateHTML.ts

@@ -1,11 +1,12 @@
-import { Node } from 'prosemirror-model'
-import getSchema from './getSchema'
-import getHTMLFromFragment from './getHTMLFromFragment'
-import { Extensions } from '../types'
+import { Node } from '@tiptap/pm/model'
 
-export default function generateHTML(doc: object, extensions: Extensions): string {
+import { Extensions, JSONContent } from '../types'
+import { getHTMLFromFragment } from './getHTMLFromFragment'
+import { getSchema } from './getSchema'
+
+export function generateHTML(doc: JSONContent, extensions: Extensions): string {
   const schema = getSchema(extensions)
   const contentNode = Node.fromJSON(schema, doc)
 
-  return getHTMLFromFragment(contentNode, schema)
+  return getHTMLFromFragment(contentNode.content, schema)
 }

package/src/helpers/generateJSON.ts

@@ -0,0 +1,12 @@
+import { DOMParser } from '@tiptap/pm/model'
+
+import { Extensions } from '../types'
+import { elementFromString } from '../utilities/elementFromString'
+import { getSchema } from './getSchema'
+
+export function generateJSON(html: string, extensions: Extensions): Record<string, any> {
+  const schema = getSchema(extensions)
+  const dom = elementFromString(html)
+
+  return DOMParser.fromSchema(schema).parse(dom).toJSON()
+}

package/src/helpers/generateText.ts

@@ -0,0 +1,27 @@
+import { Node } from '@tiptap/pm/model'
+
+import { Extensions, JSONContent, TextSerializer } from '../types'
+import { getSchema } from './getSchema'
+import { getText } from './getText'
+import { getTextSerializersFromSchema } from './getTextSerializersFromSchema'
+
+export function generateText(
+  doc: JSONContent,
+  extensions: Extensions,
+  options?: {
+    blockSeparator?: string
+    textSerializers?: Record<string, TextSerializer>
+  },
+): string {
+  const { blockSeparator = '\n\n', textSerializers = {} } = options || {}
+  const schema = getSchema(extensions)
+  const contentNode = Node.fromJSON(schema, doc)
+
+  return getText(contentNode, {
+    blockSeparator,
+    textSerializers: {
+      ...getTextSerializersFromSchema(schema),
+      ...textSerializers,
+    },
+  })
+}

package/src/helpers/getAttributes.ts

@@ -0,0 +1,26 @@
+import { MarkType, NodeType } from '@tiptap/pm/model'
+import { EditorState } from '@tiptap/pm/state'
+
+import { getMarkAttributes } from './getMarkAttributes'
+import { getNodeAttributes } from './getNodeAttributes'
+import { getSchemaTypeNameByName } from './getSchemaTypeNameByName'
+
+export function getAttributes(
+  state: EditorState,
+  typeOrName: string | NodeType | MarkType,
+): Record<string, any> {
+  const schemaType = getSchemaTypeNameByName(
+    typeof typeOrName === 'string' ? typeOrName : typeOrName.name,
+    state.schema,
+  )
+
+  if (schemaType === 'node') {
+    return getNodeAttributes(state, typeOrName as NodeType)
+  }
+
+  if (schemaType === 'mark') {
+    return getMarkAttributes(state, typeOrName as MarkType)
+  }
+
+  return {}
+}

package/src/helpers/getAttributesFromExtensions.ts

@@ -1,17 +1,20 @@
-import splitExtensions from './splitExtensions'
+import { MarkConfig, NodeConfig } from '..'
 import {
-  Extensions,
-  GlobalAttributes,
-  Attributes,
+  AnyConfig,
   Attribute,
+  Attributes,
   ExtensionAttribute,
+  Extensions,
+  GlobalAttributes,
 } from '../types'
+import { getExtensionField } from './getExtensionField'
+import { splitExtensions } from './splitExtensions'
 
 /**
  * Get a list of all extension attributes defined in `addAttribute` and `addGlobalAttribute`.
  * @param extensions List of extensions
  */
-export default function getAttributesFromExtensions(extensions: Extensions): ExtensionAttribute[] {
+export function getAttributesFromExtensions(extensions: Extensions): ExtensionAttribute[] {
   const extensionAttributes: ExtensionAttribute[] = []
   const { nodeExtensions, markExtensions } = splitExtensions(extensions)
   const nodeAndMarkExtensions = [...nodeExtensions, ...markExtensions]
@@ -21,18 +24,28 @@ export default function getAttributesFromExtensions(extensions: Extensions): Ext
     renderHTML: null,
     parseHTML: null,
     keepOnSplit: true,
+    isRequired: false,
   }
 
   extensions.forEach(extension => {
     const context = {
+      name: extension.name,
       options: extension.options,
+      storage: extension.storage,
     }
 
-    if (!extension.config.addGlobalAttributes) {
+    const addGlobalAttributes = getExtensionField<AnyConfig['addGlobalAttributes']>(
+      extension,
+      'addGlobalAttributes',
+      context,
+    )
+
+    if (!addGlobalAttributes) {
       return
     }
 
-    const globalAttributes = extension.config.addGlobalAttributes.bind(context)() as GlobalAttributes
+    // TODO: remove `as GlobalAttributes`
+    const globalAttributes = addGlobalAttributes() as GlobalAttributes
 
     globalAttributes.forEach(globalAttribute => {
       globalAttribute.types.forEach(type => {
@@ -54,25 +67,40 @@ export default function getAttributesFromExtensions(extensions: Extensions): Ext
 
   nodeAndMarkExtensions.forEach(extension => {
     const context = {
+      name: extension.name,
       options: extension.options,
+      storage: extension.storage,
     }
 
-    if (!extension.config.addAttributes) {
+    const addAttributes = getExtensionField<NodeConfig['addAttributes'] | MarkConfig['addAttributes']>(
+      extension,
+      'addAttributes',
+      context,
+    )
+
+    if (!addAttributes) {
       return
     }
 
-    const attributes = extension.config.addAttributes.bind(context)() as Attributes
+    // TODO: remove `as Attributes`
+    const attributes = addAttributes() as Attributes
 
     Object
       .entries(attributes)
       .forEach(([name, attribute]) => {
+        const mergedAttr = {
+          ...defaultAttribute,
+          ...attribute,
+        }
+
+        if (attribute?.isRequired && attribute?.default === undefined) {
+          delete mergedAttr.default
+        }
+
         extensionAttributes.push({
-          type: extension.config.name,
+          type: extension.name,
           name,
-          attribute: {
-            ...defaultAttribute,
-            ...attribute,
-          },
+          attribute: mergedAttr,
         })
       })
   })