@kerebron/extension-yjs 0.2.1 → 0.3.1

package/esm/extension-yjs/src/yUndoPlugin.js

@@ -0,0 +1,86 @@
+import { Plugin } from 'prosemirror-state';
+import { ContentType, Item, Text, UndoManager, XmlElement } from 'yjs';
+import { getRelativeSelection } from './ySyncPlugin.js';
+import { ySyncPluginKey, yUndoPluginKey } from './keys.js';
+export const undo = (state) => yUndoPluginKey.getState(state)?.undoManager?.undo() != null;
+export const redo = (state) => yUndoPluginKey.getState(state)?.undoManager?.redo() != null;
+export const undoCommand = (state, dispatch) => dispatch == null
+    ? yUndoPluginKey.getState(state)?.undoManager?.canUndo()
+    : undo(state);
+export const redoCommand = (state, dispatch) => dispatch == null
+    ? yUndoPluginKey.getState(state)?.undoManager?.canRedo()
+    : redo(state);
+export const defaultProtectedNodes = new Set(['paragraph']);
+export const defaultDeleteFilter = (item, protectedNodes) => !(item instanceof Item) ||
+    !(item.content instanceof ContentType) ||
+    !(item.content.type instanceof Text ||
+        (item.content.type instanceof XmlElement &&
+            protectedNodes.has(item.content.type.nodeName))) ||
+    item.content.type._length === 0;
+export const yUndoPlugin = ({ protectedNodes = defaultProtectedNodes, trackedOrigins = [], undoManager = null, } = {}) => new Plugin({
+    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,
+            });
+            return {
+                undoManager: _undoManager,
+                prevSel: null,
+                hasUndoOps: _undoManager.undoStack.length > 0,
+                hasRedoOps: _undoManager.redoStack.length > 0,
+            };
+        },
+        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) {
+                return {
+                    undoManager,
+                    prevSel: getRelativeSelection(binding, oldState),
+                    hasUndoOps,
+                    hasRedoOps,
+                };
+            }
+            else {
+                if (hasUndoOps !== val.hasUndoOps || hasRedoOps !== val.hasRedoOps) {
+                    return Object.assign({}, val, {
+                        hasUndoOps: undoManager.undoStack.length > 0,
+                        hasRedoOps: undoManager.redoStack.length > 0,
+                    });
+                }
+                else { // nothing changed
+                    return val;
+                }
+            }
+        },
+    },
+    view: (view) => {
+        const ystate = ySyncPluginKey.getState(view.state);
+        const undoManager = yUndoPluginKey.getState(view.state).undoManager;
+        undoManager.on('stack-item-added', ({ stackItem }) => {
+            const binding = ystate.binding;
+            if (binding) {
+                stackItem.meta.set(binding, yUndoPluginKey.getState(view.state).prevSel);
+            }
+        });
+        undoManager.on('stack-item-popped', ({ stackItem }) => {
+            const binding = ystate.binding;
+            if (binding) {
+                binding.beforeTransactionSelection = stackItem.meta.get(binding) ||
+                    binding.beforeTransactionSelection;
+            }
+        });
+        return {
+            destroy: () => {
+                undoManager.destroy();
+            },
+        };
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kerebron/extension-yjs",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "license": "MIT",
   "module": "./esm/extension-yjs/src/ExtensionYjs.js",
   "exports": {
@@ -13,12 +13,10 @@
   },
   "scripts": {},
   "dependencies": {
-    "prosemirror-keymap": "1.2.2",
-    "prosemirror-model": "1.25.1",
+    "prosemirror-model": "1.25.2",
     "prosemirror-state": "1.4.3",
     "prosemirror-transform": "1.10.4",
     "prosemirror-view": "1.40.0",
-    "y-prosemirror": "1.3.6",
     "yjs": "13.6.24"
   },
   "devDependencies": {

package/LICENSE

@@ -1,23 +0,0 @@
-Permission is hereby granted, free of charge, to any
-person obtaining a copy of this software and associated
-documentation files (the "Software"), to deal in the
-Software without restriction, including without
-limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software
-is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice
-shall be included in all copies or substantial portions
-of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
-ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
-TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
-SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
-IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,57 +0,0 @@
-# Kerebron - Prosemirror based online editor kit
-
-## Watch a Demo
-
-<a href="https://youtube.com/shorts/OdJjhAPj-wA?feature=share" target="_blank">
-  <img src="https://github.com/user-attachments/assets/b63ec84a-0ed2-4f98-920c-76f6d3215168" alt="Alt Text" width="200">
-</a>
-
-## Playground Demo
-
-[playground](https://editor-test.gitgis.com) - be nice.
-
-## Overview
-
-Using vanilla Prosemirror modules is often impossible because of
-incompatibilities.
-
-Kerebron forks several prosemirror projects into one monorepo in order to keep
-them in sync.
-
-Project is inspired on https://tiptap.dev/, but instead of building wrapper
-around a wrapper it borrows concept of extension and command manager.
-
-It has simplified tooling (deno), fewer dependencies and resulting in lower
-number of output npm modules.
-
-**Work in progress**
-
-## Development
-
-To start example server:
-
-```
-deno task -f example-server-hono start
-```
-
-## Build
-
-# NPM packages are generated using DNT
-
-- https://deno.com/blog/publish-esm-cjs-module-dnt - the easiest way to publish
-  a hybrid npm module for ESM and CommonJS
-- https://github.com/denoland/dnt
-- https://gaubee.com/article/Publishing-Your-Deno-Project-as-a-Monorepo-using-dnt/
-
-To generate npm packages
-
-```shell
-deno -A ./scripts/build_npm.ts
-```
-
-## Run through docker
-
-```
-docker build . -t editor-test
-docker run -it -p 8000:8000 -v $PWD:/usr/src/app editor-test
-```

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}