import { Extension } from '@tiptap/core' import { UndoManager } from 'yjs' import { redo, undo, ySyncPlugin, yUndoPlugin, yUndoPluginKey, } from 'y-prosemirror' declare module '@tiptap/core' { interface Commands { collaboration: { /** * Undo recent changes */ undo: () => ReturnType, /** * Reapply reverted changes */ redo: () => ReturnType, } } } export interface CollaborationOptions { /** * An initialized Y.js document. */ document: any, /** * Name of a Y.js fragment, can be changed to sync multiple fields with one Y.js document. */ field: string, /** * A raw Y.js fragment, can be used instead of `document` and `field`. */ fragment: any, } export const Collaboration = Extension.create({ name: 'collaboration', priority: 1000, defaultOptions: { document: null, field: 'default', fragment: null, }, onCreate() { if (this.editor.extensionManager.extensions.find(extension => extension.name === 'history')) { console.warn('[tiptap warn]: "@tiptap/extension-collaboration" comes with its own history support and is not compatible with "@tiptap/extension-history".') } }, addCommands() { return { undo: () => ({ tr, state, dispatch }) => { tr.setMeta('preventDispatch', true) const undoManager: UndoManager = yUndoPluginKey.getState(state).undoManager if (undoManager.undoStack.length === 0) { return false } if (!dispatch) { return true } return undo(state) }, redo: () => ({ tr, state, dispatch }) => { tr.setMeta('preventDispatch', true) const undoManager: UndoManager = yUndoPluginKey.getState(state).undoManager if (undoManager.redoStack.length === 0) { return false } if (!dispatch) { return true } return redo(state) }, } }, addKeyboardShortcuts() { return { 'Mod-z': () => this.editor.commands.undo(), 'Mod-y': () => this.editor.commands.redo(), 'Shift-Mod-z': () => this.editor.commands.redo(), } }, addProseMirrorPlugins() { const fragment = this.options.fragment ? this.options.fragment : this.options.document.getXmlFragment(this.options.field) return [ ySyncPlugin(fragment), yUndoPlugin(), ] }, })