@hocuspocus/provider 2.5.0 → 2.6.1

package/dist/hocuspocus-provider.cjs

@@ -1679,9 +1679,11 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         };
         this.subscribedToBroadcastChannel = false;
         this.webSocket = null;
+        this.webSocketHandlers = {};
         this.shouldConnect = true;
         this.status = exports.WebSocketStatus.Disconnected;
         this.lastMessageReceived = 0;
+        this.identifier = 0;
         this.mux = createMutex();
         this.intervals = {
             forceSync: null,
@@ -1693,7 +1695,9 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         this.boundConnect = this.connect.bind(this);
         this.closeTries = 0;
         this.setConfiguration(configuration);
-        this.configuration.WebSocketPolyfill = configuration.WebSocketPolyfill ? configuration.WebSocketPolyfill : WebSocket;
+        this.configuration.WebSocketPolyfill = configuration.WebSocketPolyfill
+            ? configuration.WebSocketPolyfill
+            : WebSocket;
         this.on('open', this.configuration.onOpen);
         this.on('open', this.onOpen.bind(this));
         this.on('connect', this.configuration.onConnect);
@@ -1708,7 +1712,6 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         this.on('awarenessChange', this.configuration.onAwarenessChange);
         this.on('close', this.onClose.bind(this));
         this.on('message', this.onMessage.bind(this));
-        this.registerEventListeners();
         this.intervals.connectionChecker = setInterval(this.checkConnection.bind(this), this.configuration.messageReconnectTimeout / 10);
         if (typeof configuration.connect !== 'undefined') {
             this.shouldConnect = configuration.connect;
@@ -1787,23 +1790,52 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         this.cancelWebsocketRetry = cancelFunc;
         return retryPromise;
     }
+    attachWebSocketListeners(ws, reject) {
+        const { identifier } = ws;
+        const onMessageHandler = (payload) => this.emit('message', payload);
+        const onCloseHandler = (payload) => this.emit('close', { event: payload });
+        const onOpenHandler = (payload) => this.emit('open', payload);
+        const onErrorHandler = (err) => {
+            reject(err);
+        };
+        this.webSocketHandlers[identifier] = {
+            message: onMessageHandler,
+            close: onCloseHandler,
+            open: onOpenHandler,
+            error: onErrorHandler,
+        };
+        const handlers = this.webSocketHandlers[ws.identifier];
+        Object.keys(handlers).forEach(name => {
+            ws.addEventListener(name, handlers[name]);
+        });
+    }
+    cleanupWebSocket() {
+        if (!this.webSocket) {
+            return;
+        }
+        const { identifier } = this.webSocket;
+        const handlers = this.webSocketHandlers[identifier];
+        Object.keys(handlers).forEach(name => {
+            var _a;
+            (_a = this.webSocket) === null || _a === void 0 ? void 0 : _a.removeEventListener(name, handlers[name]);
+            delete this.webSocketHandlers[identifier];
+        });
+        this.webSocket.close();
+        this.webSocket = null;
+    }
     createWebSocketConnection() {
         return new Promise((resolve, reject) => {
             if (this.webSocket) {
                 this.messageQueue = [];
-                this.webSocket.close();
-                this.webSocket = null;
+                this.cleanupWebSocket();
             }
             this.lastMessageReceived = 0;
+            this.identifier += 1;
             // Init the WebSocket connection
             const ws = new this.configuration.WebSocketPolyfill(this.url);
             ws.binaryType = 'arraybuffer';
-            ws.onmessage = (payload) => this.emit('message', payload);
-            ws.onclose = (payload) => this.emit('close', { event: payload });
-            ws.onopen = (payload) => this.emit('open', payload);
-            ws.onerror = (err) => {
-                reject(err);
-            };
+            ws.identifier = this.identifier;
+            this.attachWebSocketListeners(ws, reject);
             this.webSocket = ws;
             // Reset the status
             this.status = exports.WebSocketStatus.Connecting;
@@ -1849,7 +1881,8 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             return;
         }
         // Don’t close the connection when a message was received recently
-        if (this.configuration.messageReconnectTimeout >= getUnixTime() - this.lastMessageReceived) {
+        if (this.configuration.messageReconnectTimeout
+            >= getUnixTime() - this.lastMessageReceived) {
             return;
         }
         // No message received in a long time, not even your own
@@ -1871,12 +1904,6 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             this.messageQueue = [];
         }
     }
-    registerEventListeners() {
-        if (typeof window === 'undefined') {
-            return;
-        }
-        window.addEventListener('online', this.boundConnect);
-    }
     // Ensure that the URL always ends with /
     get serverUrl() {
         while (this.configuration.url[this.configuration.url.length - 1] === '/') {
@@ -1912,7 +1939,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
     }
     onClose({ event }) {
         this.closeTries = 0;
-        this.webSocket = null;
+        this.cleanupWebSocket();
         if (this.status === exports.WebSocketStatus.Connected) {
             this.status = exports.WebSocketStatus.Disconnected;
             this.emit('status', { status: exports.WebSocketStatus.Disconnected });
@@ -1970,10 +1997,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         this.stopConnectionAttempt();
         this.disconnect();
         this.removeAllListeners();
-        if (typeof window === 'undefined') {
-            return;
-        }
-        window.removeEventListener('online', this.boundConnect);
+        this.cleanupWebSocket();
     }
 }
 
@@ -2572,6 +2596,9 @@ class HocuspocusProvider extends EventEmitter {
     }
     // not needed, but provides backward compatibility with e.g. lexicla/yjs
     async connect() {
+        if (this.configuration.broadcast) {
+            this.subscribeToBroadcastChannel();
+        }
         return this.configuration.websocketProvider.connect();
     }
     disconnect() {
@@ -2703,11 +2730,16 @@ class HocuspocusProvider extends EventEmitter {
             this.subscribedToBroadcastChannel = true;
         }
         this.mux(() => {
-            this.broadcast(SyncStepOneMessage, { document: this.document });
-            this.broadcast(SyncStepTwoMessage, { document: this.document });
-            this.broadcast(QueryAwarenessMessage, { document: this.document });
+            this.broadcast(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
+            this.broadcast(SyncStepTwoMessage, { document: this.document, documentName: this.configuration.name });
+            this.broadcast(QueryAwarenessMessage, { document: this.document, documentName: this.configuration.name });
             if (this.awareness) {
-                this.broadcast(AwarenessMessage, { awareness: this.awareness, clients: [this.document.clientID], document: this.document });
+                this.broadcast(AwarenessMessage, {
+                    awareness: this.awareness,
+                    clients: [this.document.clientID],
+                    document: this.document,
+                    documentName: this.configuration.name,
+                });
             }
         });
     }
@@ -2760,36 +2792,45 @@ class TiptapCollabProvider extends HocuspocusProvider {
         super(configuration);
         this.tiptapCollabConfigurationPrefix = '__tiptapcollab__';
     }
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     */
     createVersion(name) {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
         return this.sendStateless(JSON.stringify({ action: 'version.create', name }));
     }
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     */
     revertToVersion(targetVersion) {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
-        return this.sendStateless(JSON.stringify({ action: 'version.revert', version: targetVersion }));
+        return this.sendStateless(JSON.stringify({ action: 'document.revert', version: targetVersion }));
     }
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     *
+     * The server will reply with a stateless message (THistoryVersionPreviewEvent)
+     */
+    previewVersion(targetVersion) {
+        return this.sendStateless(JSON.stringify({ action: 'version.preview', version: targetVersion }));
+    }
+    /**
+     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
+     */
     getVersions() {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
         return this.configuration.document.getArray(`${this.tiptapCollabConfigurationPrefix}versions`).toArray();
     }
     watchVersions(callback) {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
         return this.configuration.document.getArray('__tiptapcollab__versions').observe(callback);
     }
     unwatchVersions(callback) {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
         return this.configuration.document.getArray('__tiptapcollab__versions').unobserve(callback);
     }
     isAutoVersioning() {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
         return !!this.configuration.document.getMap(`${this.tiptapCollabConfigurationPrefix}config`).get('autoVersioning');
     }
     enableAutoVersioning() {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
         return this.configuration.document.getMap(`${this.tiptapCollabConfigurationPrefix}config`).set('autoVersioning', 1);
     }
     disableAutoVersioning() {
-        console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev');
         return this.configuration.document.getMap(`${this.tiptapCollabConfigurationPrefix}config`).set('autoVersioning', 0);
     }
 }