@kerebron/extension-yjs 0.6.6 → 0.7.0

package/src/yUndoPlugin.ts

@@ -1,38 +1,48 @@
 import { EditorState, Plugin } from 'prosemirror-state';
 import { ContentType, Item, Text, UndoManager, XmlElement } from 'yjs';
+import * as Y from 'yjs';
 
 import type { Command } from '@kerebron/editor/commands';
 
 import { ySyncPluginKey, yUndoPluginKey } from './keys.js';
-import { getRelativeSelection } from './ProsemirrorBinding.js';
+import { getRelativeSelection } from './ui/selection.js';
+import { YjsData } from './binding/PmYjsBinding.js';
+import { YSyncPluginState } from './ySyncPlugin.js';
 
 export interface UndoPluginState {
-  undoManager: UndoManager;
-  prevSel: ReturnType<typeof getRelativeSelection> | null;
+  xmlFragment?: Y.XmlFragment;
+  undoManager?: UndoManager;
+  prevSel?: ReturnType<typeof getRelativeSelection>;
   hasUndoOps: boolean;
   hasRedoOps: boolean;
 }
 
-export const undo = (state: EditorState): boolean =>
-  yUndoPluginKey.getState(state)?.undoManager?.undo() != null;
+export const undo: Command = (state: EditorState): boolean => {
+  const tr = state.tr;
+  tr.setMeta('preventDispatch', true);
+  return !!(yUndoPluginKey.getState(state)?.undoManager?.undo());
+};
 
-export const redo = (state: EditorState): boolean =>
-  yUndoPluginKey.getState(state)?.undoManager?.redo() != null;
+export const redo: Command = (state: EditorState): boolean => {
+  const tr = state.tr;
+  tr.setMeta('preventDispatch', true);
+  return !!(yUndoPluginKey.getState(state)?.undoManager?.redo());
+};
 
 export const undoCommand: Command = (state, dispatch) =>
-  dispatch == null
-    ? yUndoPluginKey.getState(state)?.undoManager?.canUndo()
+  !dispatch
+    ? !!(yUndoPluginKey.getState(state)?.undoManager?.canUndo())
     : undo(state);
 
 export const redoCommand: Command = (state, dispatch) =>
-  dispatch == null
-    ? yUndoPluginKey.getState(state)?.undoManager?.canRedo()
+  !dispatch
+    ? !!(yUndoPluginKey.getState(state)?.undoManager?.canRedo())
     : redo(state);
 
 export const defaultProtectedNodes = new Set(['paragraph']);
 
 export const defaultDeleteFilter = (
-  item: import('yjs').Item,
+  item: Y.Item,
   protectedNodes: Set<string>,
 ): boolean =>
   !(item instanceof Item) ||
@@ -45,78 +55,119 @@ export const defaultDeleteFilter = (
 export const yUndoPlugin = ({
   protectedNodes = defaultProtectedNodes,
   trackedOrigins = [],
-  undoManager = null,
 }: {
   protectedNodes?: Set<string>;
   trackedOrigins?: any[];
-  undoManager?: import('yjs').UndoManager | null;
 } = {}) =>
-  new Plugin({
+  new Plugin<UndoPluginState>({
     key: yUndoPluginKey,
     state: {
-      init: (initargs, state) => {
-        // TODO: check if plugin order matches and fix
-        const ystate = ySyncPluginKey.getState(state);
-        const _undoManager = undoManager || new UndoManager(ystate.type, {
-          trackedOrigins: new Set([ySyncPluginKey].concat(trackedOrigins)),
-          deleteFilter: (item) => defaultDeleteFilter(item, protectedNodes),
-          captureTransaction: (tr) => tr.meta.get('addToHistory') !== false,
-        });
+      init: (_initargs, _state) => {
         return {
-          undoManager: _undoManager,
-          prevSel: null,
-          hasUndoOps: _undoManager.undoStack.length > 0,
-          hasRedoOps: _undoManager.redoStack.length > 0,
+          xmlFragment: undefined,
+          undoManager: undefined,
+          prevSel: undefined,
+          hasUndoOps: false,
+          hasRedoOps: false,
         };
       },
-      apply: (tr, val, oldState, state) => {
-        const binding = ySyncPluginKey.getState(state).binding;
-        const undoManager = val.undoManager;
-        const hasUndoOps = undoManager.undoStack.length > 0;
-        const hasRedoOps = undoManager.redoStack.length > 0;
-        if (binding) {
+      apply: (tr, val: UndoPluginState, oldState, state) => {
+        const clearYjs = tr.getMeta('clearYjs');
+        if (clearYjs) {
+          const undoManager = val.undoManager;
+          if (undoManager) {
+            undoManager?.destroy();
+          }
+
+          return {
+            xmlFragment: undefined,
+            undoManager: undefined,
+            prevSel: undefined,
+            hasUndoOps: false,
+            hasRedoOps: false,
+          };
+        }
+
+        const setYjs: YjsData | undefined = tr.getMeta('setYjs');
+        if (setYjs) {
+          const { xmlFragment } = setYjs;
+          const undoManager = new UndoManager(xmlFragment, {
+            trackedOrigins: new Set([ySyncPluginKey].concat(trackedOrigins)),
+            deleteFilter: (item) => defaultDeleteFilter(item, protectedNodes),
+            captureTransaction: (ytr) => {
+              return ytr.meta.get('addToYjsHistory') !== false;
+            },
+          });
+
+          const ystate: YSyncPluginState = ySyncPluginKey.getState(oldState)!;
+          undoManager.on('stack-item-added', ({ stackItem }) => {
+            const yUndoPluginState = yUndoPluginKey.getState(oldState);
+            const binding = ystate.binding;
+            if (binding && yUndoPluginState) {
+              stackItem.meta.set(
+                binding,
+                yUndoPluginState.prevSel,
+              );
+            }
+          });
+          undoManager.on('stack-item-popped', ({ stackItem }) => {
+            const binding = ystate.binding;
+            if (binding) {
+              const beforeTransactionSelection = stackItem.meta.get(binding);
+              if (beforeTransactionSelection) {
+                const selectionStash = binding.getSelectionStash();
+                if (selectionStash) {
+                  selectionStash.overwrite(beforeTransactionSelection);
+                }
+              }
+            }
+          });
+
           return {
             undoManager,
-            prevSel: getRelativeSelection(binding, oldState),
-            hasUndoOps,
-            hasRedoOps,
+            xmlFragment,
+            prevSel: undefined,
+            hasUndoOps: undoManager.undoStack.length > 0,
+            hasRedoOps: undoManager.redoStack.length > 0,
           };
-        } else {
+        }
+
+        if (val.undoManager && val.xmlFragment) {
+          const undoManager = val.undoManager;
+          const hasUndoOps = undoManager.undoStack.length > 0;
+          const hasRedoOps = undoManager.redoStack.length > 0;
+
+          const ystate = ySyncPluginKey.getState(state)!;
+          const binding = ystate.binding;
+          if (binding) {
+            return {
+              ...val,
+              prevSel: getRelativeSelection(
+                val.xmlFragment,
+                binding.getMapping(),
+                oldState,
+              ),
+              hasUndoOps,
+              hasRedoOps,
+            };
+          }
+
           if (hasUndoOps !== val.hasUndoOps || hasRedoOps !== val.hasRedoOps) {
-            return Object.assign({}, val, {
+            return {
+              ...val,
               hasUndoOps: undoManager.undoStack.length > 0,
               hasRedoOps: undoManager.redoStack.length > 0,
-            });
-          } else { // nothing changed
-            return val;
+            };
           }
         }
+        return val;
       },
     },
     view: (view) => {
-      const ystate = ySyncPluginKey.getState(view.state);
-      const yUndoPlugin = yUndoPluginKey.getState(view.state);
-      const undoManager = yUndoPlugin?.undoManager;
-      if (undoManager) {
-        undoManager.on('stack-item-added', ({ stackItem }) => {
-          const binding = ystate.binding;
-          if (binding) {
-            stackItem.meta.set(
-              binding,
-              yUndoPlugin.prevSel,
-            );
-          }
-        });
-        undoManager.on('stack-item-popped', ({ stackItem }) => {
-          const binding = ystate.binding;
-          if (binding) {
-            binding.beforeTransactionSelection = stackItem.meta.get(binding) ||
-              binding.beforeTransactionSelection;
-          }
-        });
-      }
       return {
         destroy: () => {
+          const yUndoPluginState = yUndoPluginKey.getState(view.state);
+          const undoManager = yUndoPluginState?.undoManager;
           undoManager?.destroy();
         },
       };

package/esm/ProsemirrorBinding.d.ts

@@ -1,60 +0,0 @@
-import { mutex } from 'lib0/mutex';
-import { Node } from 'prosemirror-model';
-import { EditorState, Transaction } from 'prosemirror-state';
-import * as Y from 'yjs';
-import { ProsemirrorMapping } from './lib.js';
-import { type ColorDef, type YSyncPluginState } from './ySyncPlugin.js';
-export declare const defaultColors: Array<ColorDef>;
-export interface BindingMetadata {
-    mapping: ProsemirrorMapping;
-    isOMark: Map<string, boolean>;
-}
-interface TransactionSelection {
-    type: string;
-    anchor: Y.RelativePosition;
-    head: Y.RelativePosition;
-}
-export declare const getRelativeSelection: (pmbinding: ProsemirrorBinding, state: EditorState) => TransactionSelection;
-interface IEditorView {
-    state: EditorState;
-    dispatch(tr: Transaction): void;
-    fake?: boolean;
-}
-/**
- * Binding for prosemirror.
- *
- * @protected
- */
-export declare class ProsemirrorBinding implements BindingMetadata {
-    readonly mapping: ProsemirrorMapping;
-    ydoc: Y.Doc;
-    isOMark: Map<string, boolean>;
-    type: Y.XmlFragment;
-    readonly mux: mutex;
-    prosemirrorView?: IEditorView;
-    private _beforeTransactionSelection;
-    private readonly beforeAllTransactions;
-    private readonly afterAllTransactions;
-    private _observeFunction;
-    private _domSelectionInView;
-    get beforeTransactionSelection(): TransactionSelection | null;
-    set beforeTransactionSelection(value: TransactionSelection);
-    constructor(yXmlFragment: Y.XmlFragment, mapping?: ProsemirrorMapping);
-    changeRoom(yXmlFragment: Y.XmlFragment): void;
-    debug(msg?: string): void;
-    _isLocalCursorInView(): boolean;
-    _isDomSelectionInView(): boolean;
-    renderSnapshot(snapshot: Y.Snapshot | undefined, prevSnapshot: Y.Snapshot | undefined): void;
-    unrenderSnapshot(): void;
-    _forceRerender(): void;
-    _renderSnapshot(snapshot: Y.Snapshot | Uint8Array | undefined, prevSnapshot: Y.Snapshot | Uint8Array, pluginState: YSyncPluginState): void;
-    yXmlChanged(events: Array<Y.YEvent<any>>, transaction: Y.Transaction): void;
-    prosemirrorChanged(doc: Node): void;
-    /**
-     * View is ready to listen to changes. Register observers.
-     */
-    initView(prosemirrorView?: IEditorView): void;
-    destroy(): void;
-}
-export {};
-//# sourceMappingURL=ProsemirrorBinding.d.ts.map

package/esm/ProsemirrorBinding.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ProsemirrorBinding.d.ts","sourceRoot":"","sources":["../src/ProsemirrorBinding.ts"],"names":[],"mappings":"AAMA,OAAO,EAAe,KAAK,EAAE,MAAM,YAAY,CAAC;AAIhD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAEL,WAAW,EAIX,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAKzB,OAAO,EAEL,kBAAkB,EAEnB,MAAM,UAAU,CAAC;AAMlB,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGxE,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,QAAQ,CAGxC,CAAC;AAmBH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,kBAAkB,CAAC;IAC5B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,UAAU,oBAAoB;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,CAAC,CAAC,gBAAgB,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC,gBAAgB,CAAC;CAC1B;AAyDD,eAAO,MAAM,oBAAoB,GAC/B,WAAW,kBAAkB,EAC7B,OAAO,WAAW,KACjB,oBAYD,CAAC;AAEH,UAAU,WAAW;IACnB,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,CAAC,EAAE,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,YAAW,eAAe;aAsBtC,OAAO,EAAE,kBAAkB;IArBtC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC;IACZ,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC;IAC3B,SAAgB,GAAG,EAAE,KAAK,CAAC;IACpB,eAAe,CAAC,EAAE,WAAW,CAAC;IAErC,OAAO,CAAC,2BAA2B,CAAqC;IACxE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAa;IACnD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAa;IAElD,OAAO,CAAC,gBAAgB,CAAyC;IACjE,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,IAAI,0BAA0B,IAAI,oBAAoB,GAAG,IAAI,CAE5D;IACD,IAAI,0BAA0B,CAAC,KAAK,EAAE,oBAAoB,EAEzD;gBAGC,YAAY,EAAE,CAAC,CAAC,WAAW,EACX,OAAO,GAAE,kBAA8B;IAsCzD,UAAU,CAAC,YAAY,EAAE,CAAC,CAAC,WAAW;IAUtC,KAAK,CAAC,GAAG,SAAqB;IAI9B,oBAAoB,IAAI,OAAO;IAY/B,qBAAqB,IAAI,OAAO;IA6BhC,cAAc,CACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ,GAAG,SAAS,EAChC,YAAY,EAAE,CAAC,CAAC,QAAQ,GAAG,SAAS;IAgBtC,gBAAgB;IA+BhB,cAAc;IAsDd,eAAe,CACb,QAAQ,EAAE,CAAC,CAAC,QAAQ,GAAG,UAAU,GAAG,SAAS,EAC7C,YAAY,EAAE,CAAC,CAAC,QAAQ,GAAG,UAAU,EACrC,WAAW,EAAE,gBAAgB;IA+H/B,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW;IAiEpE,kBAAkB,CAAC,GAAG,EAAE,IAAI;IAa5B;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,WAAW;IAUtC,OAAO;CAcR"}