@tiptap/core 2.0.0-beta.99 → 2.0.0-rc.1

package/src/inputRules/wrappingInputRule.ts

@@ -0,0 +1,84 @@
+import { Node as ProseMirrorNode, NodeType } from '@tiptap/pm/model'
+import { canJoin, findWrapping } from '@tiptap/pm/transform'
+
+import { Editor } from '../Editor'
+import { InputRule, InputRuleFinder } from '../InputRule'
+import { ExtendedRegExpMatchArray } from '../types'
+import { callOrReturn } from '../utilities/callOrReturn'
+
+/**
+ * Build an input rule for automatically wrapping a textblock when a
+ * given string is typed. When using a regular expresion you’ll
+ * probably want the regexp to start with `^`, so that the pattern can
+ * only occur at the start of a textblock.
+ *
+ * `type` is the type of node to wrap in.
+ *
+ * By default, if there’s a node with the same type above the newly
+ * wrapped node, the rule will try to join those
+ * two nodes. You can pass a join predicate, which takes a regular
+ * expression match and the node before the wrapped node, and can
+ * return a boolean to indicate whether a join should happen.
+ */
+export function wrappingInputRule(config: {
+  find: InputRuleFinder,
+  type: NodeType,
+  keepMarks?: boolean,
+  keepAttributes?: boolean,
+  editor?: Editor
+  getAttributes?:
+  | Record<string, any>
+  | ((match: ExtendedRegExpMatchArray) => Record<string, any>)
+  | false
+  | null
+  ,
+  joinPredicate?: (match: ExtendedRegExpMatchArray, node: ProseMirrorNode) => boolean,
+}) {
+  return new InputRule({
+    find: config.find,
+    handler: ({
+      state, range, match, chain,
+    }) => {
+      const attributes = callOrReturn(config.getAttributes, undefined, match) || {}
+      const tr = state.tr.delete(range.from, range.to)
+      const $start = tr.doc.resolve(range.from)
+      const blockRange = $start.blockRange()
+      const wrapping = blockRange && findWrapping(blockRange, config.type, attributes)
+
+      if (!wrapping) {
+        return null
+      }
+
+      tr.wrap(blockRange, wrapping)
+
+      if (config.keepMarks && config.editor) {
+        const { selection, storedMarks } = state
+        const { splittableMarks } = config.editor.extensionManager
+        const marks = storedMarks || (selection.$to.parentOffset && selection.$from.marks())
+
+        if (marks) {
+          const filteredMarks = marks.filter(mark => splittableMarks.includes(mark.type.name))
+
+          tr.ensureMarks(filteredMarks)
+        }
+      }
+      if (config.keepAttributes) {
+        /** If the nodeType is `bulletList` or `orderedList` set the `nodeType` as `listItem` */
+        const nodeType = config.type.name === 'bulletList' || config.type.name === 'orderedList' ? 'listItem' : 'taskList'
+
+        chain().updateAttributes(nodeType, attributes).run()
+      }
+
+      const before = tr.doc.resolve(range.from - 1).nodeBefore
+
+      if (
+        before
+        && before.type === config.type
+        && canJoin(tr.doc, range.from - 1)
+        && (!config.joinPredicate || config.joinPredicate(match, before))
+      ) {
+        tr.join(range.from - 1)
+      }
+    },
+  })
+}

package/src/pasteRules/index.ts

@@ -0,0 +1,3 @@
+export * from './markPasteRule'
+export * from './nodePasteRule'
+export * from './textPasteRule'

package/src/pasteRules/markPasteRule.ts

@@ -1,76 +1,69 @@
-import { Plugin, PluginKey } from 'prosemirror-state'
-import { Slice, Fragment, MarkType } from 'prosemirror-model'
+import { MarkType } from '@tiptap/pm/model'
 
-export default function (
-  regexp: RegExp,
-  type: MarkType,
+import { getMarksBetween } from '../helpers/getMarksBetween'
+import { PasteRule, PasteRuleFinder } from '../PasteRule'
+import { ExtendedRegExpMatchArray } from '../types'
+import { callOrReturn } from '../utilities/callOrReturn'
+
+/**
+ * Build an paste rule that adds a mark when the
+ * matched text is pasted into it.
+ */
+export function markPasteRule(config: {
+  find: PasteRuleFinder
+  type: MarkType
   getAttributes?:
     | Record<string, any>
-    | ((match: RegExpExecArray) => Record<string, any>)
+    | ((match: ExtendedRegExpMatchArray) => Record<string, any>)
     | false
     | null
-  ,
-): Plugin {
-  const handler = (fragment: Fragment, parent?: any) => {
-    const nodes: any[] = []
+}) {
+  return new PasteRule({
+    find: config.find,
+    handler: ({ state, range, match }) => {
+      const attributes = callOrReturn(config.getAttributes, undefined, match)
 
-    fragment.forEach(child => {
-      if (child.isText && child.text) {
-        const { text } = child
-        let pos = 0
-        let match
+      if (attributes === false || attributes === null) {
+        return null
+      }
 
-        // eslint-disable-next-line
-        while ((match = regexp.exec(text)) !== null) {
-          const outerMatch = Math.max(match.length - 2, 0)
-          const innerMatch = Math.max(match.length - 1, 0)
+      const { tr } = state
+      const captureGroup = match[match.length - 1]
+      const fullMatch = match[0]
+      let markEnd = range.to
 
-          if (parent?.type.allowsMarkType(type)) {
-            const start = match.index
-            const matchStart = start + match[0].indexOf(match[outerMatch])
-            const matchEnd = matchStart + match[outerMatch].length
-            const textStart = matchStart + match[outerMatch].lastIndexOf(match[innerMatch])
-            const textEnd = textStart + match[innerMatch].length
-            const attrs = getAttributes instanceof Function
-              ? getAttributes(match)
-              : getAttributes
+      if (captureGroup) {
+        const startSpaces = fullMatch.search(/\S/)
+        const textStart = range.from + fullMatch.indexOf(captureGroup)
+        const textEnd = textStart + captureGroup.length
 
-            if (!attrs && attrs !== undefined) {
-              continue
-            }
+        const excludedMarks = getMarksBetween(range.from, range.to, state.doc)
+          .filter(item => {
+            // @ts-ignore
+            const excluded = item.mark.type.excluded as MarkType[]
 
-            // adding text before markdown to nodes
-            if (matchStart > 0) {
-              nodes.push(child.cut(pos, matchStart))
-            }
+            return excluded.find(type => type === config.type && type !== item.mark.type)
+          })
+          .filter(item => item.to > textStart)
 
-            // adding the markdown part to nodes
-            nodes.push(child
-              .cut(textStart, textEnd)
-              .mark(type.create(attrs).addToSet(child.marks)))
+        if (excludedMarks.length) {
+          return null
+        }
 
-            pos = matchEnd
-          }
+        if (textEnd < range.to) {
+          tr.delete(textEnd, range.to)
         }
 
-        // adding rest of text to nodes
-        if (pos < text.length) {
-          nodes.push(child.cut(pos))
+        if (textStart > range.from) {
+          tr.delete(range.from + startSpaces, textStart)
         }
-      } else {
-        nodes.push(child.copy(handler(child.content, child)))
-      }
-    })
 
-    return Fragment.fromArray(nodes)
-  }
+        markEnd = range.from + startSpaces + captureGroup.length
+
+        tr.addMark(range.from + startSpaces, markEnd, config.type.create(attributes || {}))
 
-  return new Plugin({
-    key: new PluginKey('markPasteRule'),
-    props: {
-      transformPasted: slice => {
-        return new Slice(handler(slice.content), slice.openStart, slice.openEnd)
-      },
+        tr.removeStoredMark(config.type)
+      }
     },
   })
 }

package/src/pasteRules/nodePasteRule.ts

@@ -0,0 +1,37 @@
+import { NodeType } from '@tiptap/pm/model'
+
+import { PasteRule, PasteRuleFinder } from '../PasteRule'
+import { ExtendedRegExpMatchArray } from '../types'
+import { callOrReturn } from '../utilities'
+
+/**
+ * Build an paste rule that adds a node when the
+ * matched text is pasted into it.
+ */
+export function nodePasteRule(config: {
+  find: PasteRuleFinder
+  type: NodeType
+  getAttributes?:
+    | Record<string, any>
+    | ((match: ExtendedRegExpMatchArray) => Record<string, any>)
+    | false
+    | null
+}) {
+  return new PasteRule({
+    find: config.find,
+    handler({ match, chain, range }) {
+      const attributes = callOrReturn(config.getAttributes, undefined, match)
+
+      if (attributes === false || attributes === null) {
+        return null
+      }
+
+      if (match.input) {
+        chain().deleteRange(range).insertContentAt(range.from, {
+          type: config.type.name,
+          attrs: attributes,
+        })
+      }
+    },
+  })
+}

package/src/pasteRules/textPasteRule.ts

@@ -0,0 +1,35 @@
+import { PasteRule, PasteRuleFinder } from '../PasteRule'
+
+/**
+ * Build an paste rule that replaces text when the
+ * matched text is pasted into it.
+ */
+export function textPasteRule(config: {
+  find: PasteRuleFinder,
+  replace: string,
+}) {
+  return new PasteRule({
+    find: config.find,
+    handler: ({ state, range, match }) => {
+      let insert = config.replace
+      let start = range.from
+      const end = range.to
+
+      if (match[1]) {
+        const offset = match[0].lastIndexOf(match[1])
+
+        insert += match[0].slice(offset + match[1].length)
+        start += offset
+
+        const cutOff = start - end
+
+        if (cutOff > 0) {
+          insert = match[0].slice(offset - cutOff, offset) + insert
+          start = end
+        }
+      }
+
+      state.tr.insertText(insert, start, end)
+    },
+  })
+}

package/src/style.ts

@@ -1,12 +1,14 @@
-const style = `.ProseMirror {
+export const style = `.ProseMirror {
   position: relative;
 }
 
 .ProseMirror {
   word-wrap: break-word;
   white-space: pre-wrap;
+  white-space: break-spaces;
   -webkit-font-variant-ligatures: none;
   font-variant-ligatures: none;
+  font-feature-settings: "liga" 0; /* the above doesn't seem to work in Edge */
 }
 
 .ProseMirror [contenteditable="false"] {
@@ -21,10 +23,19 @@ const style = `.ProseMirror {
   white-space: pre-wrap;
 }
 
+img.ProseMirror-separator {
+  display: inline !important;
+  border: none !important;
+  margin: 0 !important;
+  width: 1px !important;
+  height: 1px !important;
+}
+
 .ProseMirror-gapcursor {
   display: none;
   pointer-events: none;
   position: absolute;
+  margin: 0;
 }
 
 .ProseMirror-gapcursor:after {
@@ -62,5 +73,3 @@ const style = `.ProseMirror {
 .tippy-box[data-animation=fade][data-state=hidden] {
   opacity: 0
 }`
-
-export default style

package/src/types.ts

@@ -1,25 +1,18 @@
 import {
-  Node as ProseMirrorNode,
-  Mark as ProseMirrorMark,
-  ParseOptions,
-} from 'prosemirror-model'
+  Mark as ProseMirrorMark, Node as ProseMirrorNode, NodeType, ParseOptions,
+} from '@tiptap/pm/model'
+import { EditorState, Transaction } from '@tiptap/pm/state'
 import {
-  EditorView,
-  Decoration,
-  NodeView,
-  EditorProps,
-} from 'prosemirror-view'
-import { EditorState, Transaction } from 'prosemirror-state'
-import { Extension } from './Extension'
-import { Node } from './Node'
-import { Mark } from './Mark'
-import { Editor } from './Editor'
+  Decoration, EditorProps, EditorView, NodeView,
+} from '@tiptap/pm/view'
+
 import {
-  Commands,
-  ExtensionConfig,
-  NodeConfig,
-  MarkConfig,
+  Commands, ExtensionConfig, MarkConfig, NodeConfig,
 } from '.'
+import { Editor } from './Editor'
+import { Extension } from './Extension'
+import { Mark } from './Mark'
+import { Node } from './Node'
 
 export type AnyConfig = ExtensionConfig | NodeConfig | MarkConfig
 export type AnyExtension = Extension | Node | Mark
@@ -31,61 +24,80 @@ export type ParentConfig<T> = Partial<{
     : T[P]
 }>
 
+export type Primitive = null | undefined | string | number | boolean | symbol | bigint
+
 export type RemoveThis<T> = T extends (...args: any) => any
   ? (...args: Parameters<T>) => ReturnType<T>
   : T
 
-export type MaybeReturnType<T> = T extends (...args: any) => any
-  ? ReturnType<T>
-  : T
+export type MaybeReturnType<T> = T extends (...args: any) => any ? ReturnType<T> : T
+
+export type MaybeThisParameterType<T> = Exclude<T, Primitive> extends (...args: any) => any
+  ? ThisParameterType<Exclude<T, Primitive>>
+  : any
+
+export interface EditorEvents {
+  beforeCreate: { editor: Editor }
+  create: { editor: Editor }
+  update: { editor: Editor; transaction: Transaction }
+  selectionUpdate: { editor: Editor; transaction: Transaction }
+  transaction: { editor: Editor; transaction: Transaction }
+  focus: { editor: Editor; event: FocusEvent; transaction: Transaction }
+  blur: { editor: Editor; event: FocusEvent; transaction: Transaction }
+  destroy: void
+}
+
+export type EnableRules = (AnyExtension | string)[] | boolean
 
 export interface EditorOptions {
-  element: Element,
-  content: Content,
-  extensions: Extensions,
-  injectCSS: boolean,
-  autofocus: FocusPosition,
-  editable: boolean,
-  editorProps: EditorProps,
-  parseOptions: ParseOptions,
-  enableInputRules: boolean,
-  enablePasteRules: boolean,
-  onBeforeCreate: (props: { editor: Editor }) => void,
-  onCreate: (props: { editor: Editor }) => void,
-  onUpdate: (props: { editor: Editor, transaction: Transaction }) => void,
-  onSelectionUpdate: (props: { editor: Editor, transaction: Transaction }) => void,
-  onTransaction: (props: { editor: Editor, transaction: Transaction }) => void,
-  onFocus: (props: { editor: Editor, event: FocusEvent, transaction: Transaction }) => void,
-  onBlur: (props: { editor: Editor, event: FocusEvent, transaction: Transaction }) => void,
-  onDestroy: () => void,
+  element: Element
+  content: Content
+  extensions: Extensions
+  injectCSS: boolean
+  injectNonce: string | undefined
+  autofocus: FocusPosition
+  editable: boolean
+  editorProps: EditorProps
+  parseOptions: ParseOptions
+  enableInputRules: EnableRules
+  enablePasteRules: EnableRules
+  enableCoreExtensions: boolean
+  onBeforeCreate: (props: EditorEvents['beforeCreate']) => void
+  onCreate: (props: EditorEvents['create']) => void
+  onUpdate: (props: EditorEvents['update']) => void
+  onSelectionUpdate: (props: EditorEvents['selectionUpdate']) => void
+  onTransaction: (props: EditorEvents['transaction']) => void
+  onFocus: (props: EditorEvents['focus']) => void
+  onBlur: (props: EditorEvents['blur']) => void
+  onDestroy: (props: EditorEvents['destroy']) => void
 }
 
 export type HTMLContent = string
 
 export type JSONContent = {
-  type: string,
-  attrs?: Record<string, any>,
-  content?: JSONContent[],
+  type?: string
+  attrs?: Record<string, any>
+  content?: JSONContent[]
   marks?: {
-    type: string,
-    attrs?: Record<string, any>,
-    [key: string]: any,
-  }[],
-  text?: string,
-  [key: string]: any,
+    type: string
+    attrs?: Record<string, any>
+    [key: string]: any
+  }[]
+  text?: string
+  [key: string]: any
 }
 
 export type Content = HTMLContent | JSONContent | JSONContent[] | null
 
 export type CommandProps = {
-  editor: Editor,
-  tr: Transaction,
-  commands: SingleCommands,
-  can: () => CanCommands,
-  chain: () => ChainedCommands,
-  state: EditorState,
-  view: EditorView,
-  dispatch: ((args?: any) => any) | undefined,
+  editor: Editor
+  tr: Transaction
+  commands: SingleCommands
+  can: () => CanCommands
+  chain: () => ChainedCommands
+  state: EditorState
+  view: EditorView
+  dispatch: ((args?: any) => any) | undefined
 }
 
 export type Command = (props: CommandProps) => boolean
@@ -95,79 +107,87 @@ export type CommandSpec = (...args: any[]) => Command
 export type KeyboardShortcutCommand = (props: { editor: Editor }) => boolean
 
 export type Attribute = {
-  default: any,
-  rendered?: boolean,
-  renderHTML?: ((attributes: Record<string, any>) => Record<string, any> | null) | null,
-  parseHTML?: ((element: HTMLElement) => Record<string, any> | null) | null,
-  keepOnSplit: boolean,
+  default: any
+  rendered?: boolean
+  renderHTML?: ((attributes: Record<string, any>) => Record<string, any> | null) | null
+  parseHTML?: ((element: HTMLElement) => any | null) | null
+  keepOnSplit: boolean
+  isRequired?: boolean
 }
 
 export type Attributes = {
-  [key: string]: Attribute,
+  [key: string]: Attribute
 }
 
 export type ExtensionAttribute = {
-  type: string,
-  name: string,
-  attribute: Required<Attribute>,
+  type: string
+  name: string
+  attribute: Required<Attribute>
 }
 
 export type GlobalAttributes = {
-  types: string[],
+  types: string[]
   attributes: {
     [key: string]: Attribute
-  },
+  }
 }[]
 
 export type PickValue<T, K extends keyof T> = T[K]
 
-export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I)=>void)
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
+  k: infer I,
+) => void
   ? I
   : never
 
-export type Diff<T extends keyof any, U extends keyof any> =
-  ({ [P in T]: P } & { [P in U]: never } & { [x: string]: never })[T]
+export type Diff<T extends keyof any, U extends keyof any> = ({ [P in T]: P } & {
+  [P in U]: never
+} & { [x: string]: never })[T]
+
+export type Overwrite<T, U> = Pick<T, Diff<keyof T, keyof U>> & U
 
-export type Overwrite<T, U> = Pick<T, Diff<keyof T, keyof U>> & U;
+export type ValuesOf<T> = T[keyof T]
 
-export type ValuesOf<T> = T[keyof T];
+export type KeysWithTypeOf<T, Type> = { [P in keyof T]: T[P] extends Type ? P : never }[keyof T]
 
-export type KeysWithTypeOf<T, Type> = ({[P in keyof T]: T[P] extends Type ? P : never })[keyof T]
+export type DecorationWithType = Decoration & {
+  type: NodeType
+}
 
 export type NodeViewProps = {
-  editor: Editor,
-  node: ProseMirrorNode,
-  decorations: Decoration[],
-  selected: boolean,
-  extension: Node,
-  getPos: () => number,
-  updateAttributes: (attributes: Record<string, any>) => void,
-  deleteNode: () => void,
+  editor: Editor
+  node: ProseMirrorNode
+  decorations: DecorationWithType[]
+  selected: boolean
+  extension: Node
+  getPos: () => number
+  updateAttributes: (attributes: Record<string, any>) => void
+  deleteNode: () => void
 }
 
 export interface NodeViewRendererOptions {
-  stopEvent: ((props: {
-    event: Event
-  }) => boolean) | null,
-  ignoreMutation: ((props: {
-    mutation: MutationRecord | { type: 'selection', target: Element }
-  }) => boolean) | null,
+  stopEvent: ((props: { event: Event }) => boolean) | null
+  ignoreMutation:
+    | ((props: { mutation: MutationRecord | { type: 'selection'; target: Element } }) => boolean)
+    | null
 }
 
 export type NodeViewRendererProps = {
-  editor: Editor,
-  node: ProseMirrorNode,
-  getPos: (() => number) | boolean,
-  HTMLAttributes: Record<string, any>,
-  decorations: Decoration[],
-  extension: Node,
+  editor: Editor
+  node: ProseMirrorNode
+  getPos: (() => number) | boolean
+  HTMLAttributes: Record<string, any>
+  decorations: Decoration[]
+  extension: Node
 }
 
-export type NodeViewRenderer = (props: NodeViewRendererProps) => (NodeView | {})
+export type NodeViewRenderer = (props: NodeViewRendererProps) => NodeView | {}
 
 export type AnyCommands = Record<string, (...args: any[]) => Command>
 
-export type UnionCommands<T = Command> = UnionToIntersection<ValuesOf<Pick<Commands<T>, KeysWithTypeOf<Commands<T>, {}>>>>
+export type UnionCommands<T = Command> = UnionToIntersection<
+  ValuesOf<Pick<Commands<T>, KeysWithTypeOf<Commands<T>, {}>>>
+>
 
 export type RawCommands = {
   [Item in keyof UnionCommands]: UnionCommands<Command>[Item]
@@ -185,28 +205,42 @@ export type ChainedCommands = {
 
 export type CanCommands = SingleCommands & { chain: () => ChainedCommands }
 
-export type FocusPosition = 'start' | 'end' | number | boolean | null
+export type FocusPosition = 'start' | 'end' | 'all' | number | boolean | null
 
 export type Range = {
-  from: number,
-  to: number,
+  from: number
+  to: number
 }
 
 export type NodeRange = {
-  node: ProseMirrorNode,
-  from: number,
-  to: number,
+  node: ProseMirrorNode
+  from: number
+  to: number
 }
 
 export type MarkRange = {
-  mark: ProseMirrorMark,
-  from: number,
-  to: number,
+  mark: ProseMirrorMark
+  from: number
+  to: number
 }
 
 export type Predicate = (node: ProseMirrorNode) => boolean
 
 export type NodeWithPos = {
-  node: ProseMirrorNode,
-  pos: number,
+  node: ProseMirrorNode
+  pos: number
 }
+
+export type TextSerializer = (props: {
+  node: ProseMirrorNode
+  pos: number
+  parent: ProseMirrorNode
+  index: number
+  range: Range
+}) => string
+
+export type ExtendedRegExpMatchArray = RegExpMatchArray & {
+  data?: Record<string, any>
+}
+
+export type Dispatch = ((args?: any) => any) | undefined