@tiptap/core 2.1.0-rc.12 → 2.1.0-rc.13

package/dist/packages/core/src/commands/index.d.ts

@@ -17,6 +17,8 @@ export * from './forEach.js';
 export * from './insertContent.js';
 export * from './insertContentAt.js';
 export * from './join.js';
+export * from './joinItemBackward.js';
+export * from './joinItemForward.js';
 export * from './keyboardShortcut.js';
 export * from './lift.js';
 export * from './liftEmptyBlock.js';

package/dist/packages/core/src/commands/joinItemBackward.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        joinItemBackward: {
+            /**
+             * Join two nodes Forwards.
+             */
+            joinItemBackward: () => ReturnType;
+        };
+    }
+}
+export declare const joinItemBackward: RawCommands['joinItemBackward'];

package/dist/packages/core/src/commands/joinItemForward.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types.js';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        joinItemForward: {
+            /**
+             * Join two nodes Forwards.
+             */
+            joinItemForward: () => ReturnType;
+        };
+    }
+}
+export declare const joinItemForward: RawCommands['joinItemForward'];

package/dist/packages/core/src/helpers/index.d.ts

@@ -1,3 +1,4 @@
+export * from '../../../extension-list-keymap/src/listHelpers/index.js';
 export * from './combineTransactionSteps.js';
 export * from './createChainableState.js';
 export * from './createDocument.js';

package/dist/packages/core/src/helpers/isAtEndOfNode.d.ts

@@ -1,2 +1,2 @@
 import { EditorState } from '@tiptap/pm/state';
-export declare const istAtEndOfNode: (state: EditorState) => boolean;
+export declare const isAtEndOfNode: (state: EditorState, nodeType?: string) => boolean;

package/dist/packages/core/src/inputRules/nodeInputRule.d.ts

@@ -6,7 +6,27 @@ import { ExtendedRegExpMatchArray } from '../types.js';
  * matched text is typed into it.
  */
 export declare function nodeInputRule(config: {
+    /**
+     * The regex to match.
+     */
     find: InputRuleFinder;
+    /**
+     * The node type to add.
+     */
     type: NodeType;
+    /**
+     * Should the input rule replace the node or append to it
+     * If true, the node will be replaced
+     */
+    blockReplace?: boolean;
+    /**
+     * Insert empty paragraph after inserting the node
+     * Only works if blockReplace is true
+     */
+    addExtraNewline?: boolean;
+    /**
+     * A function that returns the attributes for the node
+     * can also be an object of attributes
+     */
     getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null;
 }): InputRule;

package/dist/packages/core/src/utilities/createStyleTag.d.ts

@@ -1 +1 @@
-export declare function createStyleTag(style: string, nonce?: string): HTMLStyleElement;
+export declare function createStyleTag(style: string, nonce?: string, suffix?: string): HTMLStyleElement;

package/dist/packages/extension-list-keymap/src/listHelpers/findListItemPos.d.ts

@@ -0,0 +1,6 @@
+import { NodeType } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare const findListItemPos: (typeOrName: string | NodeType, state: EditorState) => {
+    $pos: import("prosemirror-model").ResolvedPos;
+    depth: number;
+} | null;

package/dist/packages/extension-list-keymap/src/listHelpers/getNextListDepth.d.ts

@@ -0,0 +1,2 @@
+import { EditorState } from '@tiptap/pm/state';
+export declare const getNextListDepth: (typeOrName: string, state: EditorState) => number | false;

package/dist/packages/extension-list-keymap/src/listHelpers/handleBackspace.d.ts

@@ -0,0 +1,2 @@
+import { Editor } from '../../../core/src/Editor.js';
+export declare const handleBackspace: (editor: Editor, name: string, parentListTypes: string[]) => boolean;

package/dist/packages/extension-list-keymap/src/listHelpers/handleDelete.d.ts

@@ -0,0 +1,2 @@
+import { Editor } from '../../../core/src/Editor.js';
+export declare const handleDelete: (editor: Editor, name: string) => boolean;

package/dist/packages/extension-list-keymap/src/listHelpers/hasListBefore.d.ts

@@ -0,0 +1,2 @@
+import { EditorState } from '@tiptap/pm/state';
+export declare const hasListBefore: (editorState: EditorState, name: string, parentListTypes: string[]) => boolean;

package/dist/packages/extension-list-keymap/src/listHelpers/hasListItemAfter.d.ts

@@ -0,0 +1,2 @@
+import { EditorState } from '@tiptap/pm/state';
+export declare const hasListItemAfter: (typeOrName: string, state: EditorState) => boolean;

package/dist/packages/extension-list-keymap/src/listHelpers/hasListItemBefore.d.ts

@@ -0,0 +1,2 @@
+import { EditorState } from '@tiptap/pm/state';
+export declare const hasListItemBefore: (typeOrName: string, state: EditorState) => boolean;

package/dist/packages/extension-list-keymap/src/listHelpers/index.d.ts

@@ -0,0 +1,10 @@
+export * from './findListItemPos.js';
+export * from './getNextListDepth.js';
+export * from './handleBackspace.js';
+export * from './handleDelete.js';
+export * from './hasListBefore.js';
+export * from './hasListItemAfter.js';
+export * from './hasListItemBefore.js';
+export * from './listItemHasSubList.js';
+export * from './nextListIsDeeper.js';
+export * from './nextListIsHigher.js';

package/dist/packages/extension-list-keymap/src/listHelpers/listItemHasSubList.d.ts

@@ -0,0 +1,3 @@
+import { Node } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare const listItemHasSubList: (typeOrName: string, state: EditorState, node?: Node) => boolean;

package/dist/packages/extension-list-keymap/src/listHelpers/nextListIsDeeper.d.ts

@@ -0,0 +1,2 @@
+import { EditorState } from '@tiptap/pm/state';
+export declare const nextListIsDeeper: (typeOrName: string, state: EditorState) => boolean;

package/dist/packages/extension-list-keymap/src/listHelpers/nextListIsHigher.d.ts

@@ -0,0 +1,2 @@
+import { EditorState } from '@tiptap/pm/state';
+export declare const nextListIsHigher: (typeOrName: string, state: EditorState) => boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/core",
   "description": "headless rich text editor",
-  "version": "2.1.0-rc.12",
+  "version": "2.1.0-rc.13",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "devDependencies": {
-    "@tiptap/pm": "^2.1.0-rc.12"
+    "@tiptap/pm": "^2.1.0-rc.13"
   },
   "peerDependencies": {
     "@tiptap/pm": "^2.0.0"

package/src/commands/cut.ts

@@ -1,3 +1,5 @@
+import { TextSelection } from '@tiptap/pm/state'
+
 import { RawCommands } from '../types.js'
 
 declare module '@tiptap/core' {
@@ -11,17 +13,17 @@ declare module '@tiptap/core' {
   }
 }
 
-export const cut: RawCommands['cut'] = (originRange, targetPos) => ({ editor }) => {
+export const cut: RawCommands['cut'] = (originRange, targetPos) => ({ editor, tr }) => {
   const { state } = editor
 
   const contentSlice = state.doc.slice(originRange.from, originRange.to)
 
-  return editor
-    .chain()
-    .deleteRange(originRange)
-    .command(({ commands, tr }) => {
-      return commands.insertContentAt(tr.mapping.map(targetPos), contentSlice.content.toJSON())
-    })
-    .focus()
-    .run()
+  tr.deleteRange(originRange.from, originRange.to)
+  const newPos = tr.mapping.map(targetPos)
+
+  tr.insert(newPos, contentSlice.content)
+
+  tr.setSelection(new TextSelection(tr.doc.resolve(newPos - 1)))
+
+  return true
 }

package/src/commands/index.ts

@@ -17,6 +17,8 @@ export * from './forEach.js'
 export * from './insertContent.js'
 export * from './insertContentAt.js'
 export * from './join.js'
+export * from './joinItemBackward.js'
+export * from './joinItemForward.js'
 export * from './keyboardShortcut.js'
 export * from './lift.js'
 export * from './liftEmptyBlock.js'

package/src/commands/joinItemBackward.ts

@@ -0,0 +1,36 @@
+import { joinPoint } from '@tiptap/pm/transform'
+
+import { RawCommands } from '../types.js'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    joinItemBackward: {
+      /**
+       * Join two nodes Forwards.
+       */
+      joinItemBackward: () => ReturnType
+    }
+  }
+}
+
+export const joinItemBackward: RawCommands['joinItemBackward'] = () => ({
+  tr, state, dispatch,
+}) => {
+  try {
+    const point = joinPoint(state.doc, state.selection.$from.pos, -1)
+
+    if (point === null || point === undefined) {
+      return false
+    }
+
+    tr.join(point, 2)
+
+    if (dispatch) {
+      dispatch(tr)
+    }
+
+    return true
+  } catch {
+    return false
+  }
+}

package/src/commands/joinItemForward.ts

@@ -0,0 +1,38 @@
+import { joinPoint } from '@tiptap/pm/transform'
+
+import { RawCommands } from '../types.js'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    joinItemForward: {
+      /**
+       * Join two nodes Forwards.
+       */
+      joinItemForward: () => ReturnType
+    }
+  }
+}
+
+export const joinItemForward: RawCommands['joinItemForward'] = () => ({
+  state,
+  dispatch,
+  tr,
+}) => {
+  try {
+    const point = joinPoint(state.doc, state.selection.$from.pos, +1)
+
+    if (point === null || point === undefined) {
+      return false
+    }
+
+    tr.join(point, 2)
+
+    if (dispatch) {
+      dispatch(tr)
+    }
+
+    return true
+  } catch (e) {
+    return false
+  }
+}

package/src/extensions/keymap.ts

@@ -12,6 +12,7 @@ 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
@@ -32,6 +33,7 @@ export const Keymap = Extension.create({
 
         return commands.clearNodes()
       }),
+
       () => commands.deleteSelection(),
       () => commands.joinBackward(),
       () => commands.selectNodeBackward(),

package/src/helpers/index.ts

@@ -1,3 +1,4 @@
+export * from '../../../extension-list-keymap/src/listHelpers/index.js'
 export * from './combineTransactionSteps.js'
 export * from './createChainableState.js'
 export * from './createDocument.js'

package/src/helpers/isAtEndOfNode.ts

@@ -1,7 +1,25 @@
 import { EditorState } from '@tiptap/pm/state'
 
-export const istAtEndOfNode = (state: EditorState) => {
-  const { $from, $to } = state.selection
+import { findParentNode } from './findParentNode.js'
+
+export const isAtEndOfNode = (state: EditorState, nodeType?: string) => {
+  const { $from, $to, $anchor } = state.selection
+
+  if (nodeType) {
+    const parentNode = findParentNode(node => node.type.name === nodeType)(state.selection)
+
+    if (!parentNode) {
+      return false
+    }
+
+    const $parentPos = state.doc.resolve(parentNode.pos + 1)
+
+    if ($anchor.pos + 1 === $parentPos.end()) {
+      return true
+    }
+
+    return false
+  }
 
   if ($to.parentOffset < $to.parent.nodeSize - 2 || $from.pos !== $to.pos) {
     return false

package/src/inputRules/nodeInputRule.ts

@@ -1,4 +1,5 @@
 import { NodeType } from '@tiptap/pm/model'
+import { TextSelection } from '@tiptap/pm/state'
 
 import { InputRule, InputRuleFinder } from '../InputRule.js'
 import { ExtendedRegExpMatchArray } from '../types.js'
@@ -9,8 +10,32 @@ import { callOrReturn } from '../utilities/callOrReturn.js'
  * matched text is typed into it.
  */
 export function nodeInputRule(config: {
+  /**
+   * The regex to match.
+   */
   find: InputRuleFinder
+
+  /**
+   * The node type to add.
+   */
   type: NodeType
+
+  /**
+   * Should the input rule replace the node or append to it
+   * If true, the node will be replaced
+   */
+  blockReplace?: boolean
+
+  /**
+   * Insert empty paragraph after inserting the node
+   * Only works if blockReplace is true
+   */
+  addExtraNewline?: boolean
+
+  /**
+   * A function that returns the attributes for the node
+   * can also be an object of attributes
+   */
   getAttributes?:
     | Record<string, any>
     | ((match: ExtendedRegExpMatchArray) => Record<string, any>)
@@ -22,9 +47,11 @@ export function nodeInputRule(config: {
     handler: ({ state, range, match }) => {
       const attributes = callOrReturn(config.getAttributes, undefined, match) || {}
       const { tr } = state
-      const start = range.from
+      const start = config.blockReplace ? range.from - 1 : range.from
       let end = range.to
 
+      const newNode = config.type.create(attributes)
+
       if (match[1]) {
         const offset = match[0].lastIndexOf(match[1])
         let matchStart = start + offset
@@ -41,9 +68,28 @@ export function nodeInputRule(config: {
         tr.insertText(lastChar, start + match[0].length - 1)
 
         // insert node from input rule
-        tr.replaceWith(matchStart, end, config.type.create(attributes))
+        tr.replaceWith(matchStart, end, newNode)
       } else if (match[0]) {
-        tr.replaceWith(start, end, config.type.create(attributes))
+        tr.replaceWith(start, end, newNode)
+      }
+
+      if (config.blockReplace && config.addExtraNewline) {
+        const { $to } = tr.selection
+        const posAfter = $to.end()
+
+        if ($to.nodeAfter) {
+          tr.setSelection(TextSelection.create(tr.doc, $to.pos))
+        } else {
+          // add node after horizontal rule if it’s the end of the document
+          const node = $to.parent.type.contentMatch.defaultType?.create()
+
+          if (node) {
+            tr.insert(posAfter, node)
+            tr.setSelection(TextSelection.create(tr.doc, posAfter))
+          }
+        }
+
+        tr.scrollIntoView()
       }
     },
   })

package/src/utilities/createStyleTag.ts

@@ -1,5 +1,5 @@
-export function createStyleTag(style: string, nonce?: string): HTMLStyleElement {
-  const tiptapStyleTag = (<HTMLStyleElement>document.querySelector('style[data-tiptap-style]'))
+export function createStyleTag(style: string, nonce?: string, suffix?: string): HTMLStyleElement {
+  const tiptapStyleTag = (<HTMLStyleElement>document.querySelector(`style[data-tiptap-style${suffix ? `-${suffix}` : ''}]`))
 
   if (tiptapStyleTag !== null) {
     return tiptapStyleTag
@@ -11,7 +11,7 @@ export function createStyleTag(style: string, nonce?: string): HTMLStyleElement
     styleNode.setAttribute('nonce', nonce)
   }
 
-  styleNode.setAttribute('data-tiptap-style', '')
+  styleNode.setAttribute(`data-tiptap-style${suffix ? `-${suffix}` : ''}`, '')
   styleNode.innerHTML = style
   document.getElementsByTagName('head')[0].appendChild(styleNode)