@hocuspocus/provider 2.0.0-alpha.0 → 2.0.0-beta.0

package/dist/hocuspocus-provider.esm.js

@@ -1,5 +1,5 @@
 import * as Y from 'yjs';
-import { readAuthMessage, writeAuthentication, awarenessStatesToArray, WsReadyStates, Unauthorized, Forbidden } from '@hocuspocus/common';
+import { readAuthMessage, writeAuthentication, WsReadyStates, Unauthorized, Forbidden, awarenessStatesToArray } from '@hocuspocus/common';
 import { retry } from '@lifeomic/attempt';
 
 /**
@@ -1522,6 +1522,7 @@ var MessageType;
     MessageType[MessageType["Auth"] = 2] = "Auth";
     MessageType[MessageType["QueryAwareness"] = 3] = "QueryAwareness";
     MessageType[MessageType["Stateless"] = 5] = "Stateless";
+    MessageType[MessageType["CLOSE"] = 7] = "CLOSE";
 })(MessageType || (MessageType = {}));
 var WebSocketStatus;
 (function (WebSocketStatus) {
@@ -1741,615 +1742,642 @@ class UpdateMessage extends OutgoingMessage {
     }
 }
 
-class StatelessMessage extends OutgoingMessage {
-    constructor() {
-        super(...arguments);
-        this.type = MessageType.Stateless;
-        this.description = 'A stateless message';
-    }
-    get(args) {
-        var _a;
-        writeVarString(this.encoder, args.documentName);
-        writeVarUint(this.encoder, this.type);
-        writeVarString(this.encoder, (_a = args.payload) !== null && _a !== void 0 ? _a : '');
-        return this.encoder;
-    }
-}
+/**
+ * Utility module to work with urls.
+ *
+ * @module url
+ */
 
-class HocuspocusProvider extends EventEmitter {
+/**
+ * @param {Object<string,string>} params
+ * @return {string}
+ */
+const encodeQueryParams = params =>
+  map(params, (val, key) => `${encodeURIComponent(key)}=${encodeURIComponent(val)}`).join('&');
+
+class HocuspocusProviderWebsocket extends EventEmitter {
     constructor(configuration) {
         super();
         this.configuration = {
-            name: '',
+            url: '',
             // @ts-ignore
             document: undefined,
             // @ts-ignore
             awareness: undefined,
-            token: null,
+            WebSocketPolyfill: undefined,
             parameters: {},
+            connect: true,
             broadcast: true,
             forceSyncInterval: false,
-            onAuthenticated: () => null,
-            onAuthenticationFailed: () => null,
+            // TODO: this should depend on awareness.outdatedTime
+            messageReconnectTimeout: 30000,
+            // 1 second
+            delay: 1000,
+            // instant
+            initialDelay: 0,
+            // double the delay each time
+            factor: 2,
+            // unlimited retries
+            maxAttempts: 0,
+            // wait at least 1 second
+            minDelay: 1000,
+            // at least every 30 seconds
+            maxDelay: 30000,
+            // randomize
+            jitter: true,
+            // retry forever
+            timeout: 0,
             onOpen: () => null,
             onConnect: () => null,
             onMessage: () => null,
             onOutgoingMessage: () => null,
             onStatus: () => null,
-            onSynced: () => null,
             onDisconnect: () => null,
             onClose: () => null,
             onDestroy: () => null,
             onAwarenessUpdate: () => null,
             onAwarenessChange: () => null,
-            onStateless: () => null,
             quiet: false,
         };
         this.subscribedToBroadcastChannel = false;
-        this.isSynced = false;
-        this.unsyncedChanges = 0;
+        this.webSocket = null;
+        this.shouldConnect = true;
         this.status = WebSocketStatus.Disconnected;
-        this.isAuthenticated = false;
+        this.lastMessageReceived = 0;
         this.mux = createMutex();
         this.intervals = {
             forceSync: null,
+            connectionChecker: null,
         };
-        this.boundBeforeUnload = this.beforeUnload.bind(this);
-        this.boundBroadcastChannelSubscriber = this.broadcastChannelSubscriber.bind(this);
+        this.connectionAttempt = null;
+        this.receivedOnOpenPayload = undefined;
+        this.receivedOnStatusPayload = undefined;
+        this.boundConnect = this.connect.bind(this);
         this.setConfiguration(configuration);
-        this.configuration.document = configuration.document ? configuration.document : new Y.Doc();
-        this.configuration.awareness = configuration.awareness ? configuration.awareness : new Awareness(this.document);
+        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);
         this.on('message', this.configuration.onMessage);
         this.on('outgoingMessage', this.configuration.onOutgoingMessage);
-        this.on('synced', this.configuration.onSynced);
+        this.on('status', this.configuration.onStatus);
+        this.on('status', this.onStatus.bind(this));
+        this.on('disconnect', this.configuration.onDisconnect);
+        this.on('close', this.configuration.onClose);
         this.on('destroy', this.configuration.onDestroy);
         this.on('awarenessUpdate', this.configuration.onAwarenessUpdate);
         this.on('awarenessChange', this.configuration.onAwarenessChange);
-        this.on('stateless', this.configuration.onStateless);
-        this.on('authenticated', this.configuration.onAuthenticated);
-        this.on('authenticationFailed', this.configuration.onAuthenticationFailed);
-        this.configuration.websocketProvider.on('connect', this.configuration.onConnect);
-        this.configuration.websocketProvider.on('connect', (e) => this.emit('connect', e));
-        this.configuration.websocketProvider.on('open', this.onOpen.bind(this));
-        this.configuration.websocketProvider.on('open', (e) => this.emit('open', e));
-        this.configuration.websocketProvider.on('message', this.onMessage.bind(this));
-        this.configuration.websocketProvider.on('close', this.onClose.bind(this));
-        this.configuration.websocketProvider.on('close', this.configuration.onClose);
-        this.configuration.websocketProvider.on('close', (e) => this.emit('close', e));
-        this.configuration.websocketProvider.on('status', this.onStatus.bind(this));
-        this.configuration.websocketProvider.on('disconnect', this.configuration.onDisconnect);
-        this.configuration.websocketProvider.on('disconnect', (e) => this.emit('disconnect', e));
-        this.configuration.websocketProvider.on('destroy', this.configuration.onDestroy);
-        this.configuration.websocketProvider.on('destroy', (e) => this.emit('destroy', e));
-        this.awareness.on('update', () => {
-            this.emit('awarenessUpdate', { states: awarenessStatesToArray(this.awareness.getStates()) });
-        });
-        this.awareness.on('change', () => {
-            this.emit('awarenessChange', { states: awarenessStatesToArray(this.awareness.getStates()) });
-        });
-        this.document.on('update', this.documentUpdateHandler.bind(this));
-        this.awareness.on('update', this.awarenessUpdateHandler.bind(this));
+        this.on('close', this.onClose.bind(this));
+        this.on('message', this.onMessage.bind(this));
         this.registerEventListeners();
-        if (this.configuration.forceSyncInterval) {
-            this.intervals.forceSync = setInterval(this.forceSync.bind(this), this.configuration.forceSyncInterval);
+        this.intervals.connectionChecker = setInterval(this.checkConnection.bind(this), this.configuration.messageReconnectTimeout / 10);
+        if (typeof configuration.connect !== 'undefined') {
+            this.shouldConnect = configuration.connect;
         }
-        this.configuration.websocketProvider.attach(this);
-    }
-    onStatus({ status }) {
-        this.status = status;
-        this.configuration.onStatus({ status });
-        this.emit('status', { status });
-    }
-    setConfiguration(configuration = {}) {
-        this.configuration = { ...this.configuration, ...configuration };
+        if (!this.shouldConnect) {
+            return;
+        }
+        this.connect();
     }
-    get document() {
-        return this.configuration.document;
+    async onOpen(event) {
+        this.receivedOnOpenPayload = event;
     }
-    get awareness() {
-        return this.configuration.awareness;
+    async onStatus(data) {
+        this.receivedOnStatusPayload = data;
     }
-    get hasUnsyncedChanges() {
-        return this.unsyncedChanges > 0;
+    attach(provider) {
+        if (this.receivedOnOpenPayload) {
+            provider.onOpen(this.receivedOnOpenPayload);
+        }
+        if (this.receivedOnStatusPayload) {
+            provider.onStatus(this.receivedOnStatusPayload);
+        }
     }
-    forceSync() {
-        this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
+    detach(provider) {
+        // tell the server to remove the listener
     }
-    beforeUnload() {
-        removeAwarenessStates(this.awareness, [this.document.clientID], 'window unload');
+    setConfiguration(configuration = {}) {
+        this.configuration = { ...this.configuration, ...configuration };
     }
-    registerEventListeners() {
-        if (typeof window === 'undefined') {
+    async connect() {
+        if (this.status === WebSocketStatus.Connected) {
             return;
         }
-        window.addEventListener('beforeunload', this.boundBeforeUnload);
+        // Always cancel any previously initiated connection retryer instances
+        if (this.cancelWebsocketRetry) {
+            this.cancelWebsocketRetry();
+            this.cancelWebsocketRetry = undefined;
+        }
+        this.shouldConnect = true;
+        const abortableRetry = () => {
+            let cancelAttempt = false;
+            const retryPromise = retry(this.createWebSocketConnection.bind(this), {
+                delay: this.configuration.delay,
+                initialDelay: this.configuration.initialDelay,
+                factor: this.configuration.factor,
+                maxAttempts: this.configuration.maxAttempts,
+                minDelay: this.configuration.minDelay,
+                maxDelay: this.configuration.maxDelay,
+                jitter: this.configuration.jitter,
+                timeout: this.configuration.timeout,
+                beforeAttempt: context => {
+                    if (!this.shouldConnect || cancelAttempt) {
+                        context.abort();
+                    }
+                },
+            }).catch((error) => {
+                // If we aborted the connection attempt then don’t throw an error
+                // ref: https://github.com/lifeomic/attempt/blob/master/src/index.ts#L136
+                if (error && error.code !== 'ATTEMPT_ABORTED') {
+                    throw error;
+                }
+            });
+            return {
+                retryPromise,
+                cancelFunc: () => {
+                    cancelAttempt = true;
+                },
+            };
+        };
+        const { retryPromise, cancelFunc } = abortableRetry();
+        this.cancelWebsocketRetry = cancelFunc;
+        return retryPromise;
     }
-    sendStateless(payload) {
-        this.send(StatelessMessage, { documentName: this.configuration.name, payload });
+    createWebSocketConnection() {
+        return new Promise((resolve, reject) => {
+            if (this.webSocket) {
+                this.webSocket.close();
+                this.webSocket = null;
+            }
+            // 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);
+            };
+            this.webSocket = ws;
+            // Reset the status
+            this.status = WebSocketStatus.Connecting;
+            this.emit('status', { status: WebSocketStatus.Connecting });
+            // Store resolve/reject for later use
+            this.connectionAttempt = {
+                resolve,
+                reject,
+            };
+        });
     }
-    documentUpdateHandler(update, origin) {
-        if (origin === this) {
-            return;
+    onMessage(event) {
+        this.resolveConnectionAttempt();
+    }
+    resolveConnectionAttempt() {
+        if (this.connectionAttempt) {
+            this.connectionAttempt.resolve();
+            this.connectionAttempt = null;
+            this.status = WebSocketStatus.Connected;
+            this.emit('status', { status: WebSocketStatus.Connected });
+            this.emit('connect');
         }
-        this.unsyncedChanges += 1;
-        this.send(UpdateMessage, { update, documentName: this.configuration.name }, true);
     }
-    awarenessUpdateHandler({ added, updated, removed }, origin) {
-        const changedClients = added.concat(updated).concat(removed);
-        this.send(AwarenessMessage, {
-            awareness: this.awareness,
-            clients: changedClients,
-            documentName: this.configuration.name,
-        }, true);
+    stopConnectionAttempt() {
+        this.connectionAttempt = null;
     }
-    get synced() {
-        return this.isSynced;
+    rejectConnectionAttempt() {
+        var _a;
+        (_a = this.connectionAttempt) === null || _a === void 0 ? void 0 : _a.reject();
+        this.connectionAttempt = null;
     }
-    set synced(state) {
-        if (this.isSynced === state) {
+    checkConnection() {
+        var _a;
+        // Don’t check the connection when it’s not even established
+        if (this.status !== WebSocketStatus.Connected) {
             return;
         }
-        this.isSynced = state;
-        this.emit('synced', { state });
-        this.emit('sync', { state });
+        // Don’t close then connection while waiting for the first message
+        if (!this.lastMessageReceived) {
+            return;
+        }
+        // Don’t close the connection when a message was received recently
+        if (this.configuration.messageReconnectTimeout >= getUnixTime() - this.lastMessageReceived) {
+            return;
+        }
+        // No message received in a long time, not even your own
+        // Awareness updates, which are updated every 15 seconds.
+        (_a = this.webSocket) === null || _a === void 0 ? void 0 : _a.close();
     }
-    receiveStateless(payload) {
-        this.emit('stateless', { payload });
+    registerEventListeners() {
+        if (typeof window === 'undefined') {
+            return;
+        }
+        window.addEventListener('online', this.boundConnect);
     }
-    get isAuthenticationRequired() {
-        return !!this.configuration.token && !this.isAuthenticated;
+    // Ensure that the URL always ends with /
+    get serverUrl() {
+        while (this.configuration.url[this.configuration.url.length - 1] === '/') {
+            return this.configuration.url.slice(0, this.configuration.url.length - 1);
+        }
+        return this.configuration.url;
     }
-    disconnect() {
-        this.disconnectBroadcastChannel();
-        this.configuration.websocketProvider.detach(this);
+    get url() {
+        const encodedParams = encodeQueryParams(this.configuration.parameters);
+        return `${this.serverUrl}${encodedParams.length === 0 ? '' : `?${encodedParams}`}`;
     }
-    async onOpen(event) {
-        this.emit('open', { event });
-        if (this.isAuthenticationRequired) {
-            this.send(AuthenticationMessage, {
-                token: await this.getToken(),
-                documentName: this.configuration.name,
-            });
+    disconnect() {
+        this.shouldConnect = false;
+        if (this.webSocket === null) {
             return;
         }
-        this.startSync();
-    }
-    async getToken() {
-        if (typeof this.configuration.token === 'function') {
-            const token = await this.configuration.token();
-            return token;
+        try {
+            this.webSocket.close();
         }
-        return this.configuration.token;
-    }
-    startSync() {
-        this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
-        if (this.awareness.getLocalState() !== null) {
-            this.send(AwarenessMessage, {
-                awareness: this.awareness,
-                clients: [this.document.clientID],
-                documentName: this.configuration.name,
-            });
+        catch {
+            //
         }
     }
-    send(message, args, broadcast = false) {
-        if (broadcast) {
-            this.mux(() => { this.broadcast(message, args); });
+    send(message) {
+        var _a;
+        if (((_a = this.webSocket) === null || _a === void 0 ? void 0 : _a.readyState) === WsReadyStates.Open) {
+            this.webSocket.send(message);
         }
-        const messageSender = new MessageSender(message, args);
-        this.emit('outgoingMessage', { message: messageSender.message });
-        messageSender.send(this.configuration.websocketProvider);
     }
-    onMessage(event) {
-        const message = new IncomingMessage(event.data);
-        const documentName = message.readVarString();
-        if (documentName !== this.configuration.name) {
-            return; // message is meant for another provider
+    onClose({ event }) {
+        this.webSocket = null;
+        if (this.status === WebSocketStatus.Connected) {
+            this.status = WebSocketStatus.Disconnected;
+            this.emit('status', { status: WebSocketStatus.Disconnected });
+            this.emit('disconnect', { event });
         }
-        message.writeVarString(documentName);
-        this.emit('message', { event, message: new IncomingMessage(event.data) });
-        new MessageReceiver(message).apply(this);
-    }
-    onClose(event) {
-        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 (event.code === Unauthorized.code) {
+            if (event.reason === Unauthorized.reason) {
+                console.warn('[HocuspocusProvider] An authentication token is required, but you didn’t send one. Try adding a `token` to your HocuspocusProvider configuration. Won’t try again.');
+            }
+            else {
+                console.warn(`[HocuspocusProvider] Connection closed with status Unauthorized: ${event.reason}`);
+            }
+            this.shouldConnect = false;
+        }
+        if (event.code === Forbidden.code) {
+            if (!this.configuration.quiet) {
+                console.warn('[HocuspocusProvider] The provided authentication token isn’t allowed to connect to this server. Will try again.');
+                return; // TODO REMOVE ME
+            }
+        }
+        if (this.connectionAttempt) {
+            // That connection attempt failed.
+            this.rejectConnectionAttempt();
+        }
+        else if (this.shouldConnect) {
+            // The connection was closed by the server. Let’s just try again.
+            this.connect();
+        }
+        // If we’ll reconnect, we’re done for now.
+        if (this.shouldConnect) {
+            return;
+        }
+        // The status is set correctly already.
+        if (this.status === WebSocketStatus.Disconnected) {
+            return;
+        }
+        // Let’s update the connection status.
+        this.status = WebSocketStatus.Disconnected;
+        this.emit('status', { status: WebSocketStatus.Disconnected });
+        this.emit('disconnect', { event });
     }
     destroy() {
         this.emit('destroy');
         if (this.intervals.forceSync) {
             clearInterval(this.intervals.forceSync);
         }
-        removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy');
+        clearInterval(this.intervals.connectionChecker);
+        // If there is still a connection attempt outstanding then we should stop
+        // it before calling disconnect, otherwise it will be rejected in the onClose
+        // handler and trigger a retry
+        this.stopConnectionAttempt();
         this.disconnect();
-        this.awareness.off('update', this.awarenessUpdateHandler);
-        this.document.off('update', this.documentUpdateHandler);
         this.removeAllListeners();
         if (typeof window === 'undefined') {
             return;
         }
-        window.removeEventListener('beforeunload', this.boundBeforeUnload);
-    }
-    permissionDeniedHandler(reason) {
-        this.emit('authenticationFailed', { reason });
-        this.isAuthenticated = false;
-        this.disconnect();
-        this.status = WebSocketStatus.Disconnected;
-    }
-    authenticatedHandler() {
-        this.isAuthenticated = true;
-        this.emit('authenticated');
-        this.startSync();
-    }
-    get broadcastChannel() {
-        return `${this.configuration.name}`;
-    }
-    broadcastChannelSubscriber(data) {
-        this.mux(() => {
-            const message = new IncomingMessage(data);
-            const documentName = message.readVarString();
-            message.writeVarString(documentName);
-            new MessageReceiver(message)
-                .setBroadcasted(true)
-                .apply(this, false);
-        });
+        window.removeEventListener('online', this.boundConnect);
     }
-    subscribeToBroadcastChannel() {
-        if (!this.subscribedToBroadcastChannel) {
-            subscribe(this.broadcastChannel, this.boundBroadcastChannelSubscriber);
-            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(AwarenessMessage, { awareness: this.awareness, clients: [this.document.clientID], document: this.document });
-        });
+}
+
+class StatelessMessage extends OutgoingMessage {
+    constructor() {
+        super(...arguments);
+        this.type = MessageType.Stateless;
+        this.description = 'A stateless message';
     }
-    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.subscribedToBroadcastChannel) {
-            unsubscribe(this.broadcastChannel, this.boundBroadcastChannelSubscriber);
-            this.subscribedToBroadcastChannel = false;
-        }
+    get(args) {
+        var _a;
+        writeVarString(this.encoder, args.documentName);
+        writeVarUint(this.encoder, this.type);
+        writeVarString(this.encoder, (_a = args.payload) !== null && _a !== void 0 ? _a : '');
+        return this.encoder;
     }
-    broadcast(Message, args) {
-        if (!this.configuration.broadcast) {
-            return;
-        }
-        if (!this.subscribedToBroadcastChannel) {
-            return;
-        }
-        new MessageSender(Message, args).broadcast(this.broadcastChannel);
+}
+
+class CloseMessage extends OutgoingMessage {
+    constructor() {
+        super(...arguments);
+        this.type = MessageType.CLOSE;
+        this.description = 'Ask the server to close the connection';
     }
-    setAwarenessField(key, value) {
-        this.awareness.setLocalStateField(key, value);
+    get(args) {
+        writeVarString(this.encoder, args.documentName);
+        writeVarUint(this.encoder, this.type);
+        return this.encoder;
     }
 }
 
-/**
- * Utility module to work with urls.
- *
- * @module url
- */
-
-/**
- * @param {Object<string,string>} params
- * @return {string}
- */
-const encodeQueryParams = params =>
-  map(params, (val, key) => `${encodeURIComponent(key)}=${encodeURIComponent(val)}`).join('&');
-
-class HocuspocusProviderWebsocket extends EventEmitter {
+class HocuspocusProvider extends EventEmitter {
     constructor(configuration) {
         super();
         this.configuration = {
-            url: '',
+            name: '',
             // @ts-ignore
             document: undefined,
             // @ts-ignore
             awareness: undefined,
-            WebSocketPolyfill: undefined,
+            token: null,
             parameters: {},
-            connect: true,
             broadcast: true,
             forceSyncInterval: false,
-            // TODO: this should depend on awareness.outdatedTime
-            messageReconnectTimeout: 30000,
-            // 1 second
-            delay: 1000,
-            // instant
-            initialDelay: 0,
-            // double the delay each time
-            factor: 2,
-            // unlimited retries
-            maxAttempts: 0,
-            // wait at least 1 second
-            minDelay: 1000,
-            // at least every 30 seconds
-            maxDelay: 30000,
-            // randomize
-            jitter: true,
-            // retry forever
-            timeout: 0,
+            onAuthenticated: () => null,
+            onAuthenticationFailed: () => null,
             onOpen: () => null,
             onConnect: () => null,
             onMessage: () => null,
             onOutgoingMessage: () => null,
             onStatus: () => null,
+            onSynced: () => null,
             onDisconnect: () => null,
             onClose: () => null,
             onDestroy: () => null,
             onAwarenessUpdate: () => null,
             onAwarenessChange: () => null,
+            onStateless: () => null,
             quiet: false,
         };
         this.subscribedToBroadcastChannel = false;
-        this.webSocket = null;
-        this.shouldConnect = true;
+        this.isSynced = false;
+        this.unsyncedChanges = 0;
         this.status = WebSocketStatus.Disconnected;
-        this.lastMessageReceived = 0;
+        this.isAuthenticated = false;
         this.mux = createMutex();
         this.intervals = {
             forceSync: null,
-            connectionChecker: null,
         };
-        this.connectionAttempt = null;
-        this.receivedOnOpenPayload = undefined;
-        this.receivedOnStatusPayload = undefined;
-        this.boundConnect = this.connect.bind(this);
+        this.isConnected = true;
+        this.boundBeforeUnload = this.beforeUnload.bind(this);
+        this.boundBroadcastChannelSubscriber = this.broadcastChannelSubscriber.bind(this);
         this.setConfiguration(configuration);
-        this.configuration.WebSocketPolyfill = configuration.WebSocketPolyfill ? configuration.WebSocketPolyfill : WebSocket;
+        this.configuration.document = configuration.document ? configuration.document : new Y.Doc();
+        this.configuration.awareness = configuration.awareness ? configuration.awareness : new Awareness(this.document);
         this.on('open', this.configuration.onOpen);
-        this.on('open', this.onOpen.bind(this));
-        this.on('connect', this.configuration.onConnect);
         this.on('message', this.configuration.onMessage);
         this.on('outgoingMessage', this.configuration.onOutgoingMessage);
-        this.on('status', this.configuration.onStatus);
-        this.on('status', this.onStatus.bind(this));
-        this.on('disconnect', this.configuration.onDisconnect);
-        this.on('close', this.configuration.onClose);
+        this.on('synced', this.configuration.onSynced);
         this.on('destroy', this.configuration.onDestroy);
         this.on('awarenessUpdate', this.configuration.onAwarenessUpdate);
         this.on('awarenessChange', this.configuration.onAwarenessChange);
-        this.on('close', this.onClose.bind(this));
-        this.on('message', this.onMessage.bind(this));
+        this.on('stateless', this.configuration.onStateless);
+        this.on('authenticated', this.configuration.onAuthenticated);
+        this.on('authenticationFailed', this.configuration.onAuthenticationFailed);
+        this.configuration.websocketProvider.on('connect', this.configuration.onConnect);
+        this.configuration.websocketProvider.on('connect', (e) => this.emit('connect', e));
+        this.configuration.websocketProvider.on('open', this.onOpen.bind(this));
+        this.configuration.websocketProvider.on('open', (e) => this.emit('open', e));
+        this.configuration.websocketProvider.on('message', this.onMessage.bind(this));
+        this.configuration.websocketProvider.on('close', this.onClose.bind(this));
+        this.configuration.websocketProvider.on('close', this.configuration.onClose);
+        this.configuration.websocketProvider.on('close', (e) => this.emit('close', e));
+        this.configuration.websocketProvider.on('status', this.onStatus.bind(this));
+        this.configuration.websocketProvider.on('disconnect', this.configuration.onDisconnect);
+        this.configuration.websocketProvider.on('disconnect', (e) => this.emit('disconnect', e));
+        this.configuration.websocketProvider.on('destroy', this.configuration.onDestroy);
+        this.configuration.websocketProvider.on('destroy', (e) => this.emit('destroy', e));
+        this.awareness.on('update', () => {
+            this.emit('awarenessUpdate', { states: awarenessStatesToArray(this.awareness.getStates()) });
+        });
+        this.awareness.on('change', () => {
+            this.emit('awarenessChange', { states: awarenessStatesToArray(this.awareness.getStates()) });
+        });
+        this.document.on('update', this.documentUpdateHandler.bind(this));
+        this.awareness.on('update', this.awarenessUpdateHandler.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;
+        if (this.configuration.forceSyncInterval) {
+            this.intervals.forceSync = setInterval(this.forceSync.bind(this), this.configuration.forceSyncInterval);
         }
-        if (!this.shouldConnect) {
-            return;
+        this.configuration.websocketProvider.attach(this);
+    }
+    onStatus({ status }) {
+        this.status = status;
+        this.configuration.onStatus({ status });
+        this.emit('status', { status });
+    }
+    setConfiguration(configuration = {}) {
+        if (!configuration.websocketProvider && configuration.url) {
+            this.configuration.websocketProvider = new HocuspocusProviderWebsocket({ url: configuration.url });
         }
-        this.connect();
+        this.configuration = { ...this.configuration, ...configuration };
     }
-    async onOpen(event) {
-        this.receivedOnOpenPayload = event;
+    get document() {
+        return this.configuration.document;
     }
-    async onStatus(data) {
-        this.receivedOnStatusPayload = data;
+    get awareness() {
+        return this.configuration.awareness;
     }
-    attach(provider) {
-        if (this.receivedOnOpenPayload) {
-            provider.onOpen(this.receivedOnOpenPayload);
-        }
-        if (this.receivedOnStatusPayload) {
-            provider.onStatus(this.receivedOnStatusPayload);
-        }
+    get hasUnsyncedChanges() {
+        return this.unsyncedChanges > 0;
     }
-    detach(provider) {
-        // tell the server to remove the listener
+    forceSync() {
+        this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
     }
-    setConfiguration(configuration = {}) {
-        this.configuration = { ...this.configuration, ...configuration };
+    beforeUnload() {
+        removeAwarenessStates(this.awareness, [this.document.clientID], 'window unload');
     }
-    async connect() {
-        if (this.status === WebSocketStatus.Connected) {
+    registerEventListeners() {
+        if (typeof window === 'undefined') {
             return;
         }
-        // Always cancel any previously initiated connection retryer instances
-        if (this.cancelWebsocketRetry) {
-            this.cancelWebsocketRetry();
-            this.cancelWebsocketRetry = undefined;
-        }
-        this.shouldConnect = true;
-        const abortableRetry = () => {
-            let cancelAttempt = false;
-            const retryPromise = retry(this.createWebSocketConnection.bind(this), {
-                delay: this.configuration.delay,
-                initialDelay: this.configuration.initialDelay,
-                factor: this.configuration.factor,
-                maxAttempts: this.configuration.maxAttempts,
-                minDelay: this.configuration.minDelay,
-                maxDelay: this.configuration.maxDelay,
-                jitter: this.configuration.jitter,
-                timeout: this.configuration.timeout,
-                beforeAttempt: context => {
-                    if (!this.shouldConnect || cancelAttempt) {
-                        context.abort();
-                    }
-                },
-            }).catch((error) => {
-                // If we aborted the connection attempt then don’t throw an error
-                // ref: https://github.com/lifeomic/attempt/blob/master/src/index.ts#L136
-                if (error && error.code !== 'ATTEMPT_ABORTED') {
-                    throw error;
-                }
-            });
-            return {
-                retryPromise,
-                cancelFunc: () => {
-                    cancelAttempt = true;
-                },
-            };
-        };
-        const { retryPromise, cancelFunc } = abortableRetry();
-        this.cancelWebsocketRetry = cancelFunc;
-        return retryPromise;
-    }
-    createWebSocketConnection() {
-        return new Promise((resolve, reject) => {
-            if (this.webSocket) {
-                this.webSocket.close();
-                this.webSocket = null;
-            }
-            // 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);
-            };
-            this.webSocket = ws;
-            // Reset the status
-            this.status = WebSocketStatus.Connecting;
-            this.emit('status', { status: WebSocketStatus.Connecting });
-            // Store resolve/reject for later use
-            this.connectionAttempt = {
-                resolve,
-                reject,
-            };
-        });
+        window.addEventListener('beforeunload', this.boundBeforeUnload);
     }
-    onMessage(event) {
-        this.resolveConnectionAttempt();
+    sendStateless(payload) {
+        this.send(StatelessMessage, { documentName: this.configuration.name, payload });
     }
-    resolveConnectionAttempt() {
-        if (this.connectionAttempt) {
-            this.connectionAttempt.resolve();
-            this.connectionAttempt = null;
-            this.status = WebSocketStatus.Connected;
-            this.emit('status', { status: WebSocketStatus.Connected });
-            this.emit('connect');
+    documentUpdateHandler(update, origin) {
+        if (origin === this) {
+            return;
         }
+        this.unsyncedChanges += 1;
+        this.send(UpdateMessage, { update, documentName: this.configuration.name }, true);
     }
-    stopConnectionAttempt() {
-        this.connectionAttempt = null;
+    awarenessUpdateHandler({ added, updated, removed }, origin) {
+        const changedClients = added.concat(updated).concat(removed);
+        this.send(AwarenessMessage, {
+            awareness: this.awareness,
+            clients: changedClients,
+            documentName: this.configuration.name,
+        }, true);
     }
-    rejectConnectionAttempt() {
-        var _a;
-        (_a = this.connectionAttempt) === null || _a === void 0 ? void 0 : _a.reject();
-        this.connectionAttempt = null;
+    get synced() {
+        return this.isSynced;
     }
-    checkConnection() {
-        var _a;
-        // Don’t check the connection when it’s not even established
-        if (this.status !== WebSocketStatus.Connected) {
-            return;
-        }
-        // Don’t close then connection while waiting for the first message
-        if (!this.lastMessageReceived) {
-            return;
-        }
-        // Don’t close the connection when a message was received recently
-        if (this.configuration.messageReconnectTimeout >= getUnixTime() - this.lastMessageReceived) {
+    set synced(state) {
+        if (this.isSynced === state) {
             return;
         }
-        // No message received in a long time, not even your own
-        // Awareness updates, which are updated every 15 seconds.
-        (_a = this.webSocket) === null || _a === void 0 ? void 0 : _a.close();
+        this.isSynced = state;
+        this.emit('synced', { state });
+        this.emit('sync', { state });
     }
-    registerEventListeners() {
-        if (typeof window === 'undefined') {
-            return;
-        }
-        window.addEventListener('online', this.boundConnect);
+    receiveStateless(payload) {
+        this.emit('stateless', { payload });
     }
-    // Ensure that the URL always ends with /
-    get serverUrl() {
-        while (this.configuration.url[this.configuration.url.length - 1] === '/') {
-            return this.configuration.url.slice(0, this.configuration.url.length - 1);
-        }
-        return this.configuration.url;
+    get isAuthenticationRequired() {
+        return !!this.configuration.token && !this.isAuthenticated;
     }
-    get url() {
-        const encodedParams = encodeQueryParams(this.configuration.parameters);
-        return `${this.serverUrl}${encodedParams.length === 0 ? '' : `?${encodedParams}`}`;
+    // not needed, but provides backward compatibility with e.g. lexicla/yjs
+    async connect() {
+        return this.configuration.websocketProvider.connect();
     }
     disconnect() {
-        this.shouldConnect = false;
-        if (this.webSocket === null) {
-            return;
-        }
-        try {
-            this.webSocket.close();
-        }
-        catch {
-            //
-        }
+        this.disconnectBroadcastChannel();
+        this.configuration.websocketProvider.detach(this);
     }
-    send(message) {
-        var _a;
-        if (((_a = this.webSocket) === null || _a === void 0 ? void 0 : _a.readyState) === WsReadyStates.Open) {
-            this.webSocket.send(message);
+    async onOpen(event) {
+        this.emit('open', { event });
+        if (this.isAuthenticationRequired) {
+            this.send(AuthenticationMessage, {
+                token: await this.getToken(),
+                documentName: this.configuration.name,
+            });
         }
+        this.startSync();
     }
-    onClose({ event }) {
-        this.webSocket = null;
-        if (this.status === WebSocketStatus.Connected) {
-            this.status = WebSocketStatus.Disconnected;
-            this.emit('status', { status: WebSocketStatus.Disconnected });
-            this.emit('disconnect', { event });
-        }
-        if (event.code === Unauthorized.code) {
-            if (!this.configuration.quiet) {
-                console.warn('[HocuspocusProvider] An authentication token is required, but you didn’t send one. Try adding a `token` to your HocuspocusProvider configuration. Won’t try again.');
-            }
-            this.shouldConnect = false;
-        }
-        if (event.code === Forbidden.code) {
-            if (!this.configuration.quiet) {
-                console.warn('[HocuspocusProvider] The provided authentication token isn’t allowed to connect to this server. Will try again.');
-                return; // TODO REMOVE ME
-            }
-        }
-        if (this.connectionAttempt) {
-            // That connection attempt failed.
-            this.rejectConnectionAttempt();
+    async getToken() {
+        if (typeof this.configuration.token === 'function') {
+            const token = await this.configuration.token();
+            return token;
         }
-        else if (this.shouldConnect) {
-            // The connection was closed by the server. Let’s just try again.
-            this.connect();
+        return this.configuration.token;
+    }
+    startSync() {
+        this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
+        if (this.awareness.getLocalState() !== null) {
+            this.send(AwarenessMessage, {
+                awareness: this.awareness,
+                clients: [this.document.clientID],
+                documentName: this.configuration.name,
+            });
         }
-        // If we’ll reconnect, we’re done for now.
-        if (this.shouldConnect) {
+    }
+    send(message, args, broadcast = false) {
+        if (!this.isConnected)
             return;
+        if (broadcast) {
+            this.mux(() => { this.broadcast(message, args); });
         }
-        // The status is set correctly already.
-        if (this.status === WebSocketStatus.Disconnected) {
-            return;
+        const messageSender = new MessageSender(message, args);
+        this.emit('outgoingMessage', { message: messageSender.message });
+        messageSender.send(this.configuration.websocketProvider);
+    }
+    onMessage(event) {
+        const message = new IncomingMessage(event.data);
+        const documentName = message.readVarString();
+        if (documentName !== this.configuration.name) {
+            return; // message is meant for another provider
         }
-        // Let’s update the connection status.
-        this.status = WebSocketStatus.Disconnected;
-        this.emit('status', { status: WebSocketStatus.Disconnected });
-        this.emit('disconnect', { event });
+        message.writeVarString(documentName);
+        this.emit('message', { event, message: new IncomingMessage(event.data) });
+        new MessageReceiver(message).apply(this);
+    }
+    onClose(event) {
+        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);
     }
     destroy() {
         this.emit('destroy');
         if (this.intervals.forceSync) {
             clearInterval(this.intervals.forceSync);
         }
-        clearInterval(this.intervals.connectionChecker);
-        // If there is still a connection attempt outstanding then we should stop
-        // it before calling disconnect, otherwise it will be rejected in the onClose
-        // handler and trigger a retry
-        this.stopConnectionAttempt();
+        removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy');
         this.disconnect();
+        this.awareness.off('update', this.awarenessUpdateHandler);
+        this.document.off('update', this.documentUpdateHandler);
         this.removeAllListeners();
+        this.send(CloseMessage, { documentName: this.configuration.name });
+        this.isConnected = false;
         if (typeof window === 'undefined') {
             return;
         }
-        window.removeEventListener('online', this.boundConnect);
+        window.removeEventListener('beforeunload', this.boundBeforeUnload);
+    }
+    permissionDeniedHandler(reason) {
+        this.emit('authenticationFailed', { reason });
+        this.isAuthenticated = false;
+        this.disconnect();
+        this.status = WebSocketStatus.Disconnected;
+    }
+    authenticatedHandler() {
+        this.isAuthenticated = true;
+        this.emit('authenticated');
+        this.startSync();
+    }
+    get broadcastChannel() {
+        return `${this.configuration.name}`;
+    }
+    broadcastChannelSubscriber(data) {
+        this.mux(() => {
+            const message = new IncomingMessage(data);
+            const documentName = message.readVarString();
+            message.writeVarString(documentName);
+            new MessageReceiver(message)
+                .setBroadcasted(true)
+                .apply(this, false);
+        });
+    }
+    subscribeToBroadcastChannel() {
+        if (!this.subscribedToBroadcastChannel) {
+            subscribe(this.broadcastChannel, this.boundBroadcastChannelSubscriber);
+            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(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.subscribedToBroadcastChannel) {
+            unsubscribe(this.broadcastChannel, this.boundBroadcastChannelSubscriber);
+            this.subscribedToBroadcastChannel = false;
+        }
+    }
+    broadcast(Message, args) {
+        if (!this.configuration.broadcast) {
+            return;
+        }
+        if (!this.subscribedToBroadcastChannel) {
+            return;
+        }
+        new MessageSender(Message, args).broadcast(this.broadcastChannel);
+    }
+    setAwarenessField(key, value) {
+        this.awareness.setLocalStateField(key, value);
     }
 }