@kerebron/extension-yjs 0.6.7 → 0.7.1

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@kerebron/extension-yjs",
-  "version": "0.6.7",
+  "version": "0.7.1",
   "license": "MIT",
   "module": "./esm/ExtensionYjs.js",
   "exports": {
     ".": {
       "import": "./esm/ExtensionYjs.js"
     },
+    "./YjsProvider": {
+      "import": "./esm/YjsProvider.js"
+    },
+    "./WebsocketProvider": {
+      "import": "./esm/WebsocketProvider.js"
+    },
     "./MarkYChange": {
       "import": "./esm/MarkYChange.js"
     },
-    "./userColors": {
-      "import": "./esm/userColors.js"
-    },
     "./debug": {
       "import": "./esm/debug.js"
     }
@@ -23,8 +26,8 @@
     "src"
   ],
   "dependencies": {
-    "@kerebron/editor": "0.6.7",
-    "@kerebron/extension-basic-editor": "0.6.7",
+    "@kerebron/editor": "0.7.1",
+    "@kerebron/extension-basic-editor": "0.7.1",
     "lib0": "0.2.109",
     "prosemirror-model": "1.25.3",
     "prosemirror-state": "1.4.3",

package/src/ExtensionYjs.ts

@@ -1,40 +1,23 @@
-import type { Node, Schema } from 'prosemirror-model';
-import type { Plugin } from 'prosemirror-state';
+import type { EditorState, Plugin, Transaction } from 'prosemirror-state';
 
 import * as Y from 'yjs';
-import * as awarenessProtocol from 'y-protocols/awareness';
 
-import { Converter, CoreEditor, Extension } from '@kerebron/editor';
+import { Extension } from '@kerebron/editor';
 import type {
   CommandFactories,
+  CommandFactory,
   CommandShortcuts,
 } from '@kerebron/editor/commands';
 
-import { ySyncPluginKey } from './keys.js';
 import { ySyncPlugin } from './ySyncPlugin.js';
 import { yPositionPlugin } from './yPositionPlugin.js';
-import { redo, undo, yUndoPlugin } from './yUndoPlugin.js';
-
-export interface YjsProvider {
-  on(eventName: string, callback: (event: any) => void): void;
-  awareness: awarenessProtocol.Awareness;
-}
-
-function stringToIndex(str: string, arrayLength: number) {
-  let hash = 0;
-
-  for (let i = 0; i < str.length; i++) {
-    hash = (hash << 5) - hash + str.charCodeAt(i);
-    hash |= 0; // force 32-bit integer
-  }
-
-  return Math.abs(hash) % arrayLength;
-}
+import { redoCommand, undoCommand, yUndoPlugin } from './yUndoPlugin.js';
+import { ySyncPluginKey } from './keys.js';
 
-export type CreateWsProvider = (roomId: string) => [YjsProvider, Y.Doc];
+import type { CreateYjsProvider } from './YjsProvider.js';
 
 export interface YjsConfig {
-  createWsProvider: CreateWsProvider;
+  createYjsProvider: CreateYjsProvider;
 }
 
 export class ExtensionYjs extends Extension {
@@ -43,11 +26,98 @@ export class ExtensionYjs extends Extension {
   override conflicts = ['history'];
   requires = ['remote-selection'];
 
-  // declare type Command = (state: EditorState, dispatch?: (tr: Transaction) => void, view?: EditorView) => boolean;
   override getCommandFactories(): Partial<CommandFactories> {
+    const changeRoom: CommandFactory = (roomId: string) => {
+      return (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+        const tr = state.tr;
+        tr.setMeta(ySyncPluginKey, { changeRoom: { roomId } });
+
+        if (dispatch) {
+          dispatch(tr);
+        }
+
+        return true;
+      };
+    };
+
+    const leaveRoom: CommandFactory = () => {
+      return (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+        const tr = state.tr;
+        tr.setMeta(ySyncPluginKey, { leaveRoom: true });
+
+        if (dispatch) {
+          dispatch(tr);
+        }
+
+        return true;
+      };
+    };
+
+    const getYDoc: CommandFactory = (
+      { resolve, reject }: {
+        resolve: (doc: Y.Doc) => void;
+        reject: (reason: any) => void;
+      },
+    ) => {
+      return (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+        const tr = state.tr;
+        tr.setMeta(ySyncPluginKey, { getYDoc: { resolve, reject } });
+        if (dispatch) {
+          dispatch(tr);
+        }
+        return true;
+      };
+    };
+
+    const getYSnapshot: CommandFactory = (
+      { resolve, reject }: {
+        resolve: (snapshot: Uint8Array) => void;
+        reject: (reason: any) => void;
+      },
+    ) => {
+      return (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+        const tr = state.tr;
+        tr.setMeta(ySyncPluginKey, { getYSnapshot: { resolve, reject } });
+        if (dispatch) {
+          dispatch(tr);
+        }
+        return true;
+      };
+    };
+
+    const setYSnapshot: CommandFactory = (
+      opts: { prevSnapshot: Uint8Array; snapshot: Uint8Array },
+    ) => {
+      return (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+        const tr = state.tr;
+        tr.setMeta(ySyncPluginKey, { setYSnapshot: opts });
+        if (dispatch) {
+          dispatch(tr);
+        }
+        return true;
+      };
+    };
+
+    const resetYSnapshot: CommandFactory = () => {
+      return (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+        const tr = state.tr;
+        tr.setMeta(ySyncPluginKey, { resetYSnapshot: true });
+        if (dispatch) {
+          dispatch(tr);
+        }
+        return true;
+      };
+    };
+
     return {
-      'undo': () => undo,
-      'redo': () => redo,
+      getYDoc,
+      changeRoom,
+      leaveRoom,
+      'undo': () => undoCommand,
+      'redo': () => redoCommand,
+      getYSnapshot,
+      setYSnapshot,
+      resetYSnapshot,
     };
   }
 
@@ -62,48 +132,9 @@ export class ExtensionYjs extends Extension {
     super();
   }
 
-  // changeUser(userName: string) {
-  //   const idx = stringToIndex(userName, userColors.length);
-  //   const userColor = userColors[idx];
-  //   this.wsProvider.awareness.setLocalStateField('user', {
-  //     name: userName,
-  //     color: userColor.color,
-  //     colorLight: userColor.light,
-  //   });
-  // }
-  // //
-
-  override getConverters(
-    editor: CoreEditor,
-    schema: Schema,
-  ): Record<string, Converter> {
-    return {
-      'yjs': {
-        fromDoc: async (document: Node): Promise<Uint8Array> => {
-          throw new Error('Not implemented');
-        },
-        toDoc: async (buffer: Uint8Array): Promise<Node> => {
-          const roomId = new TextDecoder().decode(buffer);
-
-          const tr = editor.state.tr.setMeta(ySyncPluginKey, {
-            roomId: '',
-          });
-          editor.view.dispatch(tr);
-
-          setTimeout(() => {
-            const tr = editor.state.tr.setMeta(ySyncPluginKey, { roomId });
-            editor.view.dispatch(tr);
-          }, 100);
-
-          return schema.topNodeType.createAndFill()!;
-        },
-      },
-    };
-  }
-
   override getProseMirrorPlugins(): Plugin[] {
     return [
-      ySyncPlugin(this.editor.schema, this.config.createWsProvider),
+      ySyncPlugin(this.editor, this.config.createYjsProvider),
       yPositionPlugin(this.editor),
       yUndoPlugin(),
     ];