@kerebron/extension-yjs 0.6.7 → 0.7.1

package/esm/ExtensionYjs.d.ts

@@ -1,16 +1,9 @@
-import type { Schema } from 'prosemirror-model';
 import type { Plugin } 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, CommandShortcuts } from '@kerebron/editor/commands';
-export interface YjsProvider {
-    on(eventName: string, callback: (event: any) => void): void;
-    awareness: awarenessProtocol.Awareness;
-}
-export type CreateWsProvider = (roomId: string) => [YjsProvider, Y.Doc];
+import type { CreateYjsProvider } from './YjsProvider.js';
 export interface YjsConfig {
-    createWsProvider: CreateWsProvider;
+    createYjsProvider: CreateYjsProvider;
 }
 export declare class ExtensionYjs extends Extension {
     config: YjsConfig;
@@ -20,7 +13,6 @@ export declare class ExtensionYjs extends Extension {
     getCommandFactories(): Partial<CommandFactories>;
     getKeyboardShortcuts(): Partial<CommandShortcuts>;
     constructor(config: YjsConfig);
-    getConverters(editor: CoreEditor, schema: Schema): Record<string, Converter>;
     getProseMirrorPlugins(): Plugin[];
 }
 //# sourceMappingURL=ExtensionYjs.d.ts.map

package/esm/ExtensionYjs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExtensionYjs.d.ts","sourceRoot":"","sources":["../src/ExtensionYjs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAQ,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,KAAK,iBAAiB,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,2BAA2B,CAAC;AAOnC,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5D,SAAS,EAAE,iBAAiB,CAAC,SAAS,CAAC;CACxC;AAaD,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;AAExE,MAAM,WAAW,SAAS;IACxB,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED,qBAAa,YAAa,SAAQ,SAAS;IAqBb,MAAM,EAAE,SAAS;IApB7C,IAAI,SAAS;IAEJ,SAAS,WAAe;IACjC,QAAQ,WAAwB;IAGvB,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAOhD,oBAAoB,IAAI,OAAO,CAAC,gBAAgB,CAAC;gBAO9B,MAAM,EAAE,SAAS;IAepC,aAAa,CACpB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IAyBnB,qBAAqB,IAAI,MAAM,EAAE;CAO3C"}
+{"version":3,"file":"ExtensionYjs.d.ts","sourceRoot":"","sources":["../src/ExtensionYjs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,MAAM,EAAe,MAAM,mBAAmB,CAAC;AAI1E,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EACV,gBAAgB,EAEhB,gBAAgB,EACjB,MAAM,2BAA2B,CAAC;AAOnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,WAAW,SAAS;IACxB,iBAAiB,EAAE,iBAAiB,CAAC;CACtC;AAED,qBAAa,YAAa,SAAQ,SAAS;IA4Gb,MAAM,EAAE,SAAS;IA3G7C,IAAI,SAAS;IAEJ,SAAS,WAAe;IACjC,QAAQ,WAAwB;IAEvB,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IA+FhD,oBAAoB,IAAI,OAAO,CAAC,gBAAgB,CAAC;gBAO9B,MAAM,EAAE,SAAS;IAIpC,qBAAqB,IAAI,MAAM,EAAE;CAO3C"}

package/esm/ExtensionYjs.js

@@ -1,26 +1,83 @@
 import { Extension } from '@kerebron/editor';
-import { ySyncPluginKey } from './keys.js';
 import { ySyncPlugin } from './ySyncPlugin.js';
 import { yPositionPlugin } from './yPositionPlugin.js';
-import { redo, undo, yUndoPlugin } from './yUndoPlugin.js';
-function stringToIndex(str, arrayLength) {
-    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 class ExtensionYjs extends Extension {
     config;
     name = 'yjs';
     conflicts = ['history'];
     requires = ['remote-selection'];
-    // declare type Command = (state: EditorState, dispatch?: (tr: Transaction) => void, view?: EditorView) => boolean;
     getCommandFactories() {
+        const changeRoom = (roomId) => {
+            return (state, dispatch) => {
+                const tr = state.tr;
+                tr.setMeta(ySyncPluginKey, { changeRoom: { roomId } });
+                if (dispatch) {
+                    dispatch(tr);
+                }
+                return true;
+            };
+        };
+        const leaveRoom = () => {
+            return (state, dispatch) => {
+                const tr = state.tr;
+                tr.setMeta(ySyncPluginKey, { leaveRoom: true });
+                if (dispatch) {
+                    dispatch(tr);
+                }
+                return true;
+            };
+        };
+        const getYDoc = ({ resolve, reject }) => {
+            return (state, dispatch) => {
+                const tr = state.tr;
+                tr.setMeta(ySyncPluginKey, { getYDoc: { resolve, reject } });
+                if (dispatch) {
+                    dispatch(tr);
+                }
+                return true;
+            };
+        };
+        const getYSnapshot = ({ resolve, reject }) => {
+            return (state, dispatch) => {
+                const tr = state.tr;
+                tr.setMeta(ySyncPluginKey, { getYSnapshot: { resolve, reject } });
+                if (dispatch) {
+                    dispatch(tr);
+                }
+                return true;
+            };
+        };
+        const setYSnapshot = (opts) => {
+            return (state, dispatch) => {
+                const tr = state.tr;
+                tr.setMeta(ySyncPluginKey, { setYSnapshot: opts });
+                if (dispatch) {
+                    dispatch(tr);
+                }
+                return true;
+            };
+        };
+        const resetYSnapshot = () => {
+            return (state, dispatch) => {
+                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,
         };
     }
     getKeyboardShortcuts() {
@@ -33,40 +90,9 @@ export class ExtensionYjs extends Extension {
         super();
         this.config = config;
     }
-    // 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,
-    //   });
-    // }
-    // //
-    getConverters(editor, schema) {
-        return {
-            'yjs': {
-                fromDoc: async (document) => {
-                    throw new Error('Not implemented');
-                },
-                toDoc: async (buffer) => {
-                    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();
-                },
-            },
-        };
-    }
     getProseMirrorPlugins() {
         return [
-            ySyncPlugin(this.editor.schema, this.config.createWsProvider),
+            ySyncPlugin(this.editor, this.config.createYjsProvider),
             yPositionPlugin(this.editor),
             yUndoPlugin(),
         ];

package/esm/ExtensionYjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExtensionYjs.js","sourceRoot":"","sources":["../src/ExtensionYjs.ts"],"names":[],"mappings":"AAMA,OAAO,EAAyB,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAMpE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAO3D,SAAS,aAAa,CAAC,GAAW,EAAE,WAAmB;IACrD,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,CAAC,CAAC,uBAAuB;IACpC,CAAC;IAED,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;AACtC,CAAC;AAQD,MAAM,OAAO,YAAa,SAAQ,SAAS;IAqBb;IApB5B,IAAI,GAAG,KAAK,CAAC;IAEJ,SAAS,GAAG,CAAC,SAAS,CAAC,CAAC;IACjC,QAAQ,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAEhC,mHAAmH;IAC1G,mBAAmB;QAC1B,OAAO;YACL,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI;YAClB,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI;SACnB,CAAC;IACJ,CAAC;IAEQ,oBAAoB;QAC3B,OAAO;YACL,OAAO,EAAE,MAAM;YACf,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC;IAED,YAA4B,MAAiB;QAC3C,KAAK,EAAE,CAAC;QADkB,WAAM,GAAN,MAAM,CAAW;IAE7C,CAAC;IAED,iCAAiC;IACjC,4DAA4D;IAC5D,uCAAuC;IACvC,2DAA2D;IAC3D,sBAAsB;IACtB,8BAA8B;IAC9B,mCAAmC;IACnC,QAAQ;IACR,IAAI;IACJ,KAAK;IAEI,aAAa,CACpB,MAAkB,EAClB,MAAc;QAEd,OAAO;YACL,KAAK,EAAE;gBACL,OAAO,EAAE,KAAK,EAAE,QAAc,EAAuB,EAAE;oBACrD,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;gBACrC,CAAC;gBACD,KAAK,EAAE,KAAK,EAAE,MAAkB,EAAiB,EAAE;oBACjD,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAEhD,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE;wBACjD,MAAM,EAAE,EAAE;qBACX,CAAC,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;oBAEzB,UAAU,CAAC,GAAG,EAAE;wBACd,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;wBAC/D,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;oBAC3B,CAAC,EAAE,GAAG,CAAC,CAAC;oBAER,OAAO,MAAM,CAAC,WAAW,CAAC,aAAa,EAAG,CAAC;gBAC7C,CAAC;aACF;SACF,CAAC;IACJ,CAAC;IAEQ,qBAAqB;QAC5B,OAAO;YACL,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAC7D,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC;YAC5B,WAAW,EAAE;SACd,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"ExtensionYjs.js","sourceRoot":"","sources":["../src/ExtensionYjs.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAO7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAQ3C,MAAM,OAAO,YAAa,SAAQ,SAAS;IA4Gb;IA3G5B,IAAI,GAAG,KAAK,CAAC;IAEJ,SAAS,GAAG,CAAC,SAAS,CAAC,CAAC;IACjC,QAAQ,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAEvB,mBAAmB;QAC1B,MAAM,UAAU,GAAmB,CAAC,MAAc,EAAE,EAAE;YACpD,OAAO,CAAC,KAAkB,EAAE,QAAoC,EAAE,EAAE;gBAClE,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;gBACpB,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;gBAEvD,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC;gBAED,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,SAAS,GAAmB,GAAG,EAAE;YACrC,OAAO,CAAC,KAAkB,EAAE,QAAoC,EAAE,EAAE;gBAClE,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;gBACpB,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAEhD,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC;gBAED,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,OAAO,GAAmB,CAC9B,EAAE,OAAO,EAAE,MAAM,EAGhB,EACD,EAAE;YACF,OAAO,CAAC,KAAkB,EAAE,QAAoC,EAAE,EAAE;gBAClE,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;gBACpB,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC7D,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,YAAY,GAAmB,CACnC,EAAE,OAAO,EAAE,MAAM,EAGhB,EACD,EAAE;YACF,OAAO,CAAC,KAAkB,EAAE,QAAoC,EAAE,EAAE;gBAClE,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;gBACpB,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;gBAClE,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,YAAY,GAAmB,CACnC,IAAwD,EACxD,EAAE;YACF,OAAO,CAAC,KAAkB,EAAE,QAAoC,EAAE,EAAE;gBAClE,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;gBACpB,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnD,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,cAAc,GAAmB,GAAG,EAAE;YAC1C,OAAO,CAAC,KAAkB,EAAE,QAAoC,EAAE,EAAE;gBAClE,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;gBACpB,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;gBACrD,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,OAAO;YACL,OAAO;YACP,UAAU;YACV,SAAS;YACT,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW;YACzB,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW;YACzB,YAAY;YACZ,YAAY;YACZ,cAAc;SACf,CAAC;IACJ,CAAC;IAEQ,oBAAoB;QAC3B,OAAO;YACL,OAAO,EAAE,MAAM;YACf,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC;IAED,YAA4B,MAAiB;QAC3C,KAAK,EAAE,CAAC;QADkB,WAAM,GAAN,MAAM,CAAW;IAE7C,CAAC;IAEQ,qBAAqB;QAC5B,OAAO;YACL,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YACvD,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC;YAC5B,WAAW,EAAE;SACd,CAAC;IACJ,CAAC;CACF"}

package/esm/WebsocketProvider.d.ts

@@ -0,0 +1,70 @@
+import * as Y from 'yjs';
+import * as awarenessProtocol from 'y-protocols/awareness';
+import { MessageHandler, YjsProvider } from './YjsProvider.js';
+interface WebsocketProviderOpts {
+    connect: boolean;
+    awareness: awarenessProtocol.Awareness;
+    params: Record<string, string>;
+    protocols: Array<string>;
+    WebSocketPolyfill: typeof WebSocket;
+    resyncInterval: number;
+    maxBackoffTime: number;
+    disableBc: boolean;
+}
+/**
+ * Websocket Provider for Yjs. Creates a websocket connection to sync the shared document.
+ * The document name is attached to the provided url. I.e. the following example
+ * creates a websocket connection to http://localhost:1234/my-document-name
+ *
+ * @example
+ *   import * as Y from 'yjs'
+ *   import { WebsocketProvider } from '@kerebron/extension-yjs/WebsocketProvider'
+ *   const doc = new Y.Doc()
+ *   const provider = new WebsocketProvider('http://localhost:1234', 'my-document-name', doc)
+ */
+export declare class WebsocketProvider extends EventTarget implements YjsProvider {
+    roomname: string;
+    doc: Y.Doc;
+    _synced: boolean;
+    shouldConnect: boolean;
+    ws: WebSocket | undefined;
+    _resyncInterval: number;
+    serverUrl: string;
+    bcChannel: string;
+    maxBackoffTime: number;
+    /**
+     * The specified url parameters. This can be safely updated. The changed parameters will be used
+     * when a new connection is established.
+     */
+    params: Record<string, string>;
+    protocols: string[];
+    _WS: typeof WebSocket;
+    awareness: awarenessProtocol.Awareness;
+    destroyed: boolean;
+    wsconnected: boolean;
+    wsconnecting: boolean;
+    bcconnected: boolean;
+    disableBc: boolean;
+    wsUnsuccessfulReconnects: number;
+    messageHandlers: MessageHandler<WebsocketProvider>[];
+    wsLastMessageReceived: number;
+    readonly bc: BroadcastChannel;
+    private _bcSubscriber;
+    private _updateHandler;
+    private _awarenessUpdateHandler;
+    private _exitHandler;
+    private _checkInterval;
+    setupWSTimeout: number | undefined;
+    constructor(serverUrl: string, roomname: string, doc: Y.Doc, opts?: WebsocketProviderOpts);
+    get url(): string;
+    get synced(): boolean;
+    set synced(state: boolean);
+    destroy(): void;
+    connectBc(): void;
+    disconnectBc(): void;
+    disconnect(): void;
+    connect(): void;
+    private setupMessageHandlers;
+}
+export {};
+//# sourceMappingURL=WebsocketProvider.d.ts.map

package/esm/WebsocketProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebsocketProvider.d.ts","sourceRoot":"","sources":["../src/WebsocketProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAMzB,OAAO,KAAK,iBAAiB,MAAM,uBAAuB,CAAC;AAI3D,OAAO,EAGL,cAAc,EAId,WAAW,EACZ,MAAM,kBAAkB,CAAC;AAoJ1B,UAAU,qBAAqB;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,iBAAiB,CAAC,SAAS,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB,iBAAiB,EAAE,OAAO,SAAS,CAAC;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,iBAAkB,SAAQ,WAAY,YAAW,WAAW;IACvE,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC;IAEX,OAAO,UAAS;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,EAAE,EAAE,SAAS,GAAG,SAAS,CAAC;IAC1B,eAAe,SAAK;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,GAAG,EAAE,OAAO,SAAS,CAAC;IACtB,SAAS,EAAE,iBAAiB,CAAC,SAAS,CAAC;IACvC,SAAS,UAAS;IAClB,WAAW,UAAS;IACpB,YAAY,UAAS;IACrB,WAAW,UAAS;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,wBAAwB,EAAE,MAAM,CAAC;IACjC,eAAe,EAAE,cAAc,CAAC,iBAAiB,CAAC,EAAE,CAAC;IACrD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,SAAgB,EAAE,EAAE,gBAAgB,CAAC;IACrC,OAAO,CAAC,aAAa,CAAuC;IAC5D,OAAO,CAAC,cAAc,CAAqC;IAC3D,OAAO,CAAC,uBAAuB,CAGrB;IACV,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,cAAc,CAAS;IAC/B,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;gBAGjC,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,CAAC,CAAC,GAAG,EACV,IAAI,GAAE,qBASL;IAoGH,IAAI,GAAG,WAIN;IAED,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,EAMxB;IAED,OAAO;IAmBP,SAAS;IAyCT,YAAY;IAuBZ,UAAU;IAQV,OAAO;IAQP,OAAO,CAAC,oBAAoB;CAuE7B"}

package/esm/WebsocketProvider.js

@@ -0,0 +1,377 @@
+import * as time from 'lib0/time';
+import * as encoding from 'lib0/encoding';
+import * as decoding from 'lib0/decoding';
+import * as syncProtocol from 'y-protocols/sync';
+import * as authProtocol from 'y-protocols/auth';
+import * as awarenessProtocol from 'y-protocols/awareness';
+import * as math from 'lib0/math';
+import * as url from 'lib0/url';
+import { messageAuth, messageAwareness, messageQueryAwareness, messageSync, } from './YjsProvider.js';
+// @todo - this should depend on awareness.outdatedTime
+const messageReconnectTimeout = 30000;
+const permissionDeniedHandler = (provider, reason) => console.warn(`Permission denied to access ${provider.url}.\n${reason}`);
+const readMessage = (provider, buf, emitSynced) => {
+    const decoder = decoding.createDecoder(buf);
+    const encoder = encoding.createEncoder();
+    const messageType = decoding.readVarUint(decoder);
+    const messageHandler = provider.messageHandlers[messageType];
+    if (messageHandler) {
+        messageHandler(encoder, decoder, provider, emitSynced, messageType);
+    }
+    else {
+        console.error('Unable to compute message');
+    }
+    return encoder;
+};
+/**
+ * Outsource this function so that a new websocket connection is created immediately.
+ * I suspect that the `ws.onclose` event is not always fired if there are network issues.
+ */
+const closeWebsocketConnection = (provider, ws, event) => {
+    if (ws === provider.ws) {
+        provider.dispatchEvent(new CustomEvent('connection-close', { detail: { event, provider } }));
+        provider.ws = undefined;
+        ws.close();
+        provider.wsconnecting = false;
+        if (provider.wsconnected) {
+            provider.wsconnected = false;
+            provider.synced = false;
+            // update awareness (all users except local left)
+            awarenessProtocol.removeAwarenessStates(provider.awareness, Array.from(provider.awareness.getStates().keys()).filter((client) => client !== provider.doc.clientID), provider);
+            provider.dispatchEvent(new CustomEvent('status', { detail: { status: 'disconnected' } }));
+        }
+        else {
+            provider.wsUnsuccessfulReconnects++;
+        }
+        // Start with no reconnect timeout and increase timeout by
+        // using exponential backoff starting with 100ms
+        if (!provider.destroyed) {
+            provider.setupWSTimeout = setTimeout(setupWS, math.min(math.pow(2, provider.wsUnsuccessfulReconnects) * 100, provider.maxBackoffTime), provider);
+        }
+    }
+};
+const setupWS = (provider) => {
+    provider.setupWSTimeout = undefined;
+    if (provider.shouldConnect && !provider.ws) {
+        const websocket = new provider._WS(provider.url, provider.protocols);
+        websocket.binaryType = 'arraybuffer';
+        provider.ws = websocket;
+        provider.wsconnecting = true;
+        provider.wsconnected = false;
+        provider.synced = false;
+        websocket.onmessage = (event) => {
+            provider.wsLastMessageReceived = time.getUnixTime();
+            const encoder = readMessage(provider, new Uint8Array(event.data), true);
+            if (encoding.length(encoder) > 1) {
+                websocket.send(encoding.toUint8Array(encoder));
+            }
+        };
+        websocket.onerror = (event) => {
+            provider.dispatchEvent(new CustomEvent('connection-error', { detail: { event, provider } }));
+        };
+        websocket.onclose = (event) => {
+            try {
+                closeWebsocketConnection(provider, websocket, event);
+            }
+            catch (err) {
+                console.error(err);
+            }
+        };
+        websocket.onopen = () => {
+            provider.wsLastMessageReceived = time.getUnixTime();
+            provider.wsconnecting = false;
+            provider.wsconnected = true;
+            provider.wsUnsuccessfulReconnects = 0;
+            provider.dispatchEvent(new CustomEvent('status', { detail: { status: 'connected' } }));
+            // always send sync step 1 when connected
+            const encoder = encoding.createEncoder();
+            encoding.writeVarUint(encoder, messageSync);
+            syncProtocol.writeSyncStep1(encoder, provider.doc);
+            websocket.send(encoding.toUint8Array(encoder));
+            // broadcast local awareness state
+            if (provider.awareness.getLocalState() !== null) {
+                const encoderAwarenessState = encoding.createEncoder();
+                encoding.writeVarUint(encoderAwarenessState, messageAwareness);
+                encoding.writeVarUint8Array(encoderAwarenessState, awarenessProtocol.encodeAwarenessUpdate(provider.awareness, [
+                    provider.doc.clientID,
+                ]));
+                websocket.send(encoding.toUint8Array(encoderAwarenessState));
+            }
+        };
+        provider.dispatchEvent(new CustomEvent('status', { detail: { status: 'connecting' } }));
+    }
+};
+const broadcastMessage = (provider, buf) => {
+    const ws = provider.ws;
+    if (provider.wsconnected && ws && ws.readyState === ws.OPEN) {
+        ws.send(buf);
+    }
+    if (provider.bcconnected) {
+        try {
+            provider.bc.postMessage(buf);
+        }
+        catch (err) {
+            console.trace(err);
+        }
+    }
+};
+/**
+ * Websocket Provider for Yjs. Creates a websocket connection to sync the shared document.
+ * The document name is attached to the provided url. I.e. the following example
+ * creates a websocket connection to http://localhost:1234/my-document-name
+ *
+ * @example
+ *   import * as Y from 'yjs'
+ *   import { WebsocketProvider } from '@kerebron/extension-yjs/WebsocketProvider'
+ *   const doc = new Y.Doc()
+ *   const provider = new WebsocketProvider('http://localhost:1234', 'my-document-name', doc)
+ */
+export class WebsocketProvider extends EventTarget {
+    roomname;
+    doc;
+    _synced = false;
+    shouldConnect;
+    ws;
+    _resyncInterval = 0;
+    serverUrl;
+    bcChannel;
+    maxBackoffTime;
+    /**
+     * The specified url parameters. This can be safely updated. The changed parameters will be used
+     * when a new connection is established.
+     */
+    params;
+    protocols;
+    _WS;
+    awareness;
+    destroyed = false;
+    wsconnected = false;
+    wsconnecting = false;
+    bcconnected = false;
+    disableBc;
+    wsUnsuccessfulReconnects;
+    messageHandlers;
+    wsLastMessageReceived;
+    bc;
+    _bcSubscriber;
+    _updateHandler;
+    _awarenessUpdateHandler;
+    _exitHandler;
+    _checkInterval;
+    setupWSTimeout;
+    constructor(serverUrl, roomname, doc, opts = {
+        connect: true,
+        awareness: new awarenessProtocol.Awareness(doc),
+        params: {},
+        protocols: [],
+        WebSocketPolyfill: WebSocket,
+        resyncInterval: -1,
+        maxBackoffTime: 2500,
+        disableBc: false,
+    }) {
+        super();
+        // ensure that serverUrl does not end with /
+        this.serverUrl = serverUrl;
+        this.roomname = roomname;
+        this.doc = doc;
+        while (this.serverUrl[this.serverUrl.length - 1] === '/') {
+            this.serverUrl = this.serverUrl.slice(0, this.serverUrl.length - 1);
+        }
+        this.bcChannel = this.serverUrl + '/' + roomname;
+        this.bc = new BroadcastChannel(this.bcChannel);
+        this.maxBackoffTime = opts.maxBackoffTime;
+        this.params = opts.params;
+        this.protocols = opts.protocols;
+        this._WS = opts.WebSocketPolyfill;
+        this.awareness = opts.awareness;
+        this.disableBc = opts.disableBc;
+        this.wsUnsuccessfulReconnects = 0;
+        this.messageHandlers = this.setupMessageHandlers();
+        this.wsLastMessageReceived = 0;
+        this.shouldConnect = opts.connect;
+        if (opts.resyncInterval > 0) {
+            this._resyncInterval = setInterval(() => {
+                if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+                    // resend sync step 1
+                    const encoder = encoding.createEncoder();
+                    encoding.writeVarUint(encoder, messageSync);
+                    syncProtocol.writeSyncStep1(encoder, doc);
+                    this.ws.send(encoding.toUint8Array(encoder));
+                }
+            }, opts.resyncInterval);
+        }
+        this._bcSubscriber = (event) => {
+            readMessage(this, new Uint8Array(event.data), false);
+        };
+        /**
+         * Listens to Yjs updates and sends them to remote peers (ws and broadcastchannel)
+         */
+        this._updateHandler = (update, origin) => {
+            if (origin !== this) {
+                const encoder = encoding.createEncoder();
+                encoding.writeVarUint(encoder, messageSync);
+                syncProtocol.writeUpdate(encoder, update);
+                broadcastMessage(this, encoding.toUint8Array(encoder));
+            }
+        };
+        this.doc.on('update', this._updateHandler);
+        this._awarenessUpdateHandler = ({ added, updated, removed }, _origin) => {
+            const changedClients = added.concat(updated).concat(removed);
+            const encoder = encoding.createEncoder();
+            encoding.writeVarUint(encoder, messageAwareness);
+            encoding.writeVarUint8Array(encoder, awarenessProtocol.encodeAwarenessUpdate(opts.awareness, changedClients));
+            broadcastMessage(this, encoding.toUint8Array(encoder));
+        };
+        this._exitHandler = () => {
+            awarenessProtocol.removeAwarenessStates(this.awareness, [doc.clientID], 'app closed');
+        };
+        // if (env.isNode && typeof process !== 'undefined') {
+        //   process.on('exit', this._exitHandler);
+        // }
+        opts.awareness.on('update', this._awarenessUpdateHandler);
+        this._checkInterval = /** @type {any} */ (setInterval(() => {
+            try {
+                if (this.wsconnected &&
+                    messageReconnectTimeout <
+                        time.getUnixTime() - this.wsLastMessageReceived) {
+                    // no message received in a long time - not even your own awareness
+                    // updates (which are updated every 15 seconds)
+                    if (this.ws) {
+                        closeWebsocketConnection(this, this.ws, null);
+                    }
+                }
+            }
+            catch (err) {
+                console.error(err);
+            }
+        }, messageReconnectTimeout / 10));
+        if (opts.connect) {
+            this.connect();
+        }
+    }
+    get url() {
+        const encodedParams = url.encodeQueryParams(this.params);
+        return this.serverUrl + '/' + this.roomname +
+            (encodedParams.length === 0 ? '' : '?' + encodedParams);
+    }
+    get synced() {
+        return this._synced;
+    }
+    set synced(state) {
+        if (this._synced !== state) {
+            this._synced = state;
+            this.dispatchEvent(new CustomEvent('synced', { detail: { state } }));
+            this.dispatchEvent(new CustomEvent('sync', { detail: { state } }));
+        }
+    }
+    destroy() {
+        this.destroyed = true;
+        if (this._resyncInterval !== 0) {
+            clearInterval(this._resyncInterval);
+        }
+        if (this.setupWSTimeout) {
+            clearTimeout(this.setupWSTimeout);
+        }
+        clearInterval(this._checkInterval);
+        this.disconnect();
+        // if (env.isNode && typeof process !== 'undefined') {
+        //   process.off('exit', this._exitHandler);
+        // }
+        this.awareness.off('update', this._awarenessUpdateHandler);
+        this.doc.off('update', this._updateHandler);
+        this.awareness.destroy();
+    }
+    connectBc() {
+        if (this.disableBc) {
+            return;
+        }
+        if (!this.bcconnected) {
+            this.bc.addEventListener('message', this._bcSubscriber);
+            this.bcconnected = true;
+        }
+        try {
+            // send sync step1 to bc
+            // write sync step 1
+            const encoderSync = encoding.createEncoder();
+            encoding.writeVarUint(encoderSync, messageSync);
+            syncProtocol.writeSyncStep1(encoderSync, this.doc);
+            this.bc.postMessage(encoding.toUint8Array(encoderSync));
+            // broadcast local state
+            const encoderState = encoding.createEncoder();
+            encoding.writeVarUint(encoderState, messageSync);
+            syncProtocol.writeSyncStep2(encoderState, this.doc);
+            this.bc.postMessage(encoding.toUint8Array(encoderState));
+            // write queryAwareness
+            const encoderAwarenessQuery = encoding.createEncoder();
+            encoding.writeVarUint(encoderAwarenessQuery, messageQueryAwareness);
+            this.bc.postMessage(encoding.toUint8Array(encoderAwarenessQuery));
+            // broadcast local awareness state
+            const encoderAwarenessState = encoding.createEncoder();
+            encoding.writeVarUint(encoderAwarenessState, messageAwareness);
+            encoding.writeVarUint8Array(encoderAwarenessState, awarenessProtocol.encodeAwarenessUpdate(this.awareness, [
+                this.doc.clientID,
+            ]));
+            this.bc.postMessage(encoding.toUint8Array(encoderAwarenessState));
+        }
+        catch (err) {
+            console.trace(err);
+        }
+    }
+    disconnectBc() {
+        // broadcast message with local awareness state set to null (indicating disconnect)
+        const encoder = encoding.createEncoder();
+        encoding.writeVarUint(encoder, messageAwareness);
+        encoding.writeVarUint8Array(encoder, awarenessProtocol.encodeAwarenessUpdate(this.awareness, [
+            this.doc.clientID,
+        ], new Map()));
+        broadcastMessage(this, encoding.toUint8Array(encoder));
+        if (this.bcconnected) {
+            setTimeout(() => {
+                try {
+                    this.bc.close();
+                }
+                catch (err) {
+                    console.trace(err);
+                }
+            }, 0);
+            this.bcconnected = false;
+        }
+    }
+    disconnect() {
+        this.shouldConnect = false;
+        this.disconnectBc();
+        if (this.ws) {
+            closeWebsocketConnection(this, this.ws, null);
+        }
+    }
+    connect() {
+        this.shouldConnect = true;
+        if (!this.wsconnected && !this.ws) {
+            setupWS(this);
+            this.connectBc();
+        }
+    }
+    setupMessageHandlers() {
+        const messageHandlers = [];
+        messageHandlers[messageSync] = (encoder, decoder, provider, emitSynced, _messageType) => {
+            encoding.writeVarUint(encoder, messageSync);
+            const syncMessageType = syncProtocol.readSyncMessage(decoder, encoder, provider.doc, provider);
+            if (emitSynced && syncMessageType === syncProtocol.messageYjsSyncStep2 &&
+                !provider.synced) {
+                provider.synced = true;
+            }
+        };
+        messageHandlers[messageQueryAwareness] = (encoder, _decoder, provider, _emitSynced, _messageType) => {
+            encoding.writeVarUint(encoder, messageAwareness);
+            encoding.writeVarUint8Array(encoder, awarenessProtocol.encodeAwarenessUpdate(provider.awareness, Array.from(provider.awareness.getStates().keys())));
+        };
+        messageHandlers[messageAwareness] = (_encoder, decoder, provider, _emitSynced, _messageType) => {
+            awarenessProtocol.applyAwarenessUpdate(provider.awareness, decoding.readVarUint8Array(decoder), provider);
+        };
+        messageHandlers[messageAuth] = (_encoder, decoder, provider, _emitSynced, _messageType) => {
+            authProtocol.readAuthMessage(decoder, provider.doc, (_ydoc, reason) => permissionDeniedHandler(provider, reason));
+        };
+        return messageHandlers;
+    }
+}
+//# sourceMappingURL=WebsocketProvider.js.map