@hocuspocus/provider 2.3.1 → 2.4.0-rc.0

package/dist/hocuspocus-provider.cjs

@@ -1642,8 +1642,6 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             url: '',
             // @ts-ignore
             document: undefined,
-            // @ts-ignore
-            awareness: undefined,
             WebSocketPolyfill: undefined,
             parameters: {},
             connect: true,
@@ -1845,7 +1843,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         if (this.status !== exports.WebSocketStatus.Connected) {
             return;
         }
-        // Don’t close then connection while waiting for the first message
+        // Don’t close the connection while waiting for the first message
         if (!this.lastMessageReceived) {
             return;
         }
@@ -1854,7 +1852,8 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             return;
         }
         // No message received in a long time, not even your own
-        // Awareness updates, which are updated every 15 seconds.
+        // Awareness updates, which are updated every 15 seconds
+        // if awareness is enabled.
         this.closeTries += 1;
         // https://bugs.webkit.org/show_bug.cgi?id=247943
         if (this.closeTries > 2) {
@@ -2210,6 +2209,8 @@ class MessageReceiver {
         }
     }
     applyAwarenessMessage(provider) {
+        if (!provider.awareness)
+            return;
         const { message } = this;
         applyAwarenessUpdate(provider.awareness, message.readVarUint8Array(), provider);
     }
@@ -2218,6 +2219,8 @@ class MessageReceiver {
         common.readAuthMessage(message.decoder, provider.permissionDeniedHandler.bind(provider), provider.authenticatedHandler.bind(provider));
     }
     applyQueryAwarenessMessage(provider) {
+        if (!provider.awareness)
+            return;
         const { message } = this;
         message.writeVarUint(exports.MessageType.Awareness);
         message.writeVarUint8Array(encodeAwarenessUpdate(provider.awareness, Array.from(provider.awareness.getStates().keys())));
@@ -2375,8 +2378,15 @@ class UpdateMessage extends OutgoingMessage {
     }
 }
 
+class AwarenessError extends Error {
+    constructor() {
+        super(...arguments);
+        this.code = 1001;
+    }
+}
 class HocuspocusProvider extends EventEmitter {
     constructor(configuration) {
+        var _a, _b, _c;
         super();
         this.configuration = {
             name: '',
@@ -2430,7 +2440,7 @@ class HocuspocusProvider extends EventEmitter {
         this.forwardDestroy = (e) => this.emit('destroy', e);
         this.setConfiguration(configuration);
         this.configuration.document = configuration.document ? configuration.document : new Y__namespace.Doc();
-        this.configuration.awareness = configuration.awareness ? configuration.awareness : new Awareness(this.document);
+        this.configuration.awareness = configuration.awareness !== undefined ? configuration.awareness : new Awareness(this.document);
         this.on('open', this.configuration.onOpen);
         this.on('message', this.configuration.onMessage);
         this.on('outgoingMessage', this.configuration.onOutgoingMessage);
@@ -2454,14 +2464,14 @@ class HocuspocusProvider extends EventEmitter {
         this.configuration.websocketProvider.on('disconnect', this.forwardDisconnect);
         this.configuration.websocketProvider.on('destroy', this.configuration.onDestroy);
         this.configuration.websocketProvider.on('destroy', this.forwardDestroy);
-        this.awareness.on('update', () => {
+        (_a = this.awareness) === null || _a === void 0 ? void 0 : _a.on('update', () => {
             this.emit('awarenessUpdate', { states: common.awarenessStatesToArray(this.awareness.getStates()) });
         });
-        this.awareness.on('change', () => {
+        (_b = this.awareness) === null || _b === void 0 ? void 0 : _b.on('change', () => {
             this.emit('awarenessChange', { states: common.awarenessStatesToArray(this.awareness.getStates()) });
         });
         this.document.on('update', this.documentUpdateHandler.bind(this));
-        this.awareness.on('update', this.awarenessUpdateHandler.bind(this));
+        (_c = this.awareness) === null || _c === void 0 ? void 0 : _c.on('update', this.awarenessUpdateHandler.bind(this));
         this.registerEventListeners();
         if (this.configuration.forceSyncInterval) {
             this.intervals.forceSync = setInterval(this.forceSync.bind(this), this.configuration.forceSyncInterval);
@@ -2508,7 +2518,9 @@ class HocuspocusProvider extends EventEmitter {
         this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
     }
     pageUnload() {
-        removeAwarenessStates(this.awareness, [this.document.clientID], 'window unload');
+        if (this.awareness) {
+            removeAwarenessStates(this.awareness, [this.document.clientID], 'window unload');
+        }
     }
     registerEventListeners() {
         if (typeof window === 'undefined') {
@@ -2589,7 +2601,7 @@ class HocuspocusProvider extends EventEmitter {
     startSync() {
         this.incrementUnsyncedChanges();
         this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
-        if (this.awareness.getLocalState() !== null) {
+        if (this.awareness && this.awareness.getLocalState() !== null) {
             this.send(AwarenessMessage, {
                 awareness: this.awareness,
                 clients: [this.document.clientID],
@@ -2622,16 +2634,21 @@ class HocuspocusProvider extends EventEmitter {
         this.isAuthenticated = false;
         this.synced = false;
         // update awareness (all users except local left)
-        removeAwarenessStates(this.awareness, Array.from(this.awareness.getStates().keys()).filter(client => client !== this.document.clientID), this);
+        if (this.awareness) {
+            removeAwarenessStates(this.awareness, Array.from(this.awareness.getStates().keys()).filter(client => client !== this.document.clientID), this);
+        }
     }
     destroy() {
+        var _a;
         this.emit('destroy');
         if (this.intervals.forceSync) {
             clearInterval(this.intervals.forceSync);
         }
-        removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy');
+        if (this.awareness) {
+            removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy');
+        }
         this.disconnect();
-        this.awareness.off('update', this.awarenessUpdateHandler);
+        (_a = this.awareness) === null || _a === void 0 ? void 0 : _a.off('update', this.awarenessUpdateHandler);
         this.document.off('update', this.documentUpdateHandler);
         this.removeAllListeners();
         this.configuration.websocketProvider.off('connect', this.configuration.onConnect);
@@ -2688,17 +2705,21 @@ class HocuspocusProvider extends EventEmitter {
             this.broadcast(SyncStepOneMessage, { document: this.document });
             this.broadcast(SyncStepTwoMessage, { document: this.document });
             this.broadcast(QueryAwarenessMessage, { document: this.document });
-            this.broadcast(AwarenessMessage, { awareness: this.awareness, clients: [this.document.clientID], document: this.document });
+            if (this.awareness) {
+                this.broadcast(AwarenessMessage, { awareness: this.awareness, clients: [this.document.clientID], document: this.document });
+            }
         });
     }
     disconnectBroadcastChannel() {
         // broadcast message with local awareness state set to null (indicating disconnect)
-        this.send(AwarenessMessage, {
-            awareness: this.awareness,
-            clients: [this.document.clientID],
-            states: new Map(),
-            documentName: this.configuration.name,
-        }, true);
+        if (this.awareness) {
+            this.send(AwarenessMessage, {
+                awareness: this.awareness,
+                clients: [this.document.clientID],
+                states: new Map(),
+                documentName: this.configuration.name,
+            }, true);
+        }
         if (this.subscribedToBroadcastChannel) {
             unsubscribe(this.broadcastChannel, this.boundBroadcastChannelSubscriber);
             this.subscribedToBroadcastChannel = false;
@@ -2714,6 +2735,9 @@ class HocuspocusProvider extends EventEmitter {
         new MessageSender(Message, args).broadcast(this.broadcastChannel);
     }
     setAwarenessField(key, value) {
+        if (!this.awareness) {
+            throw new AwarenessError(`Cannot set awareness field "${key}" to ${JSON.stringify(value)}. You have disabled Awareness for this provider by explicitly passing awareness: null in the provider configuration.`);
+        }
         this.awareness.setLocalStateField(key, value);
     }
 }
@@ -2769,6 +2793,7 @@ class TiptapCollabProvider extends HocuspocusProvider {
     }
 }
 
+exports.AwarenessError = AwarenessError;
 exports.HocuspocusProvider = HocuspocusProvider;
 exports.HocuspocusProviderWebsocket = HocuspocusProviderWebsocket;
 exports.TiptapCollabProvider = TiptapCollabProvider;