@hocuspocus/provider 3.1.3 → 3.1.5

package/dist/hocuspocus-provider.esm.js

@@ -1109,7 +1109,7 @@ class EventEmitter {
     emit(event, ...args) {
         const callbacks = this.callbacks[event];
         if (callbacks) {
-            callbacks.forEach(callback => callback.apply(this, args));
+            callbacks.forEach((callback) => callback.apply(this, args));
         }
         return this;
     }
@@ -1118,7 +1118,7 @@ class EventEmitter {
         const callbacks = this.callbacks[event];
         if (callbacks) {
             if (fn) {
-                this.callbacks[event] = callbacks.filter(callback => callback !== fn);
+                this.callbacks[event] = callbacks.filter((callback) => callback !== fn);
             }
             else {
                 delete this.callbacks[event];
@@ -1196,7 +1196,7 @@ class CloseMessage extends OutgoingMessage {
     constructor() {
         super(...arguments);
         this.type = MessageType.CLOSE;
-        this.description = 'Ask the server to close the connection';
+        this.description = "Ask the server to close the connection";
     }
     get(args) {
         writeVarString(this.encoder, args.documentName);
@@ -1693,7 +1693,7 @@ class MessageReceiver {
                     reason: readVarString(message.decoder),
                     // @ts-ignore
                     target: provider.configuration.websocketProvider.webSocket,
-                    type: 'close',
+                    type: "close",
                 };
                 provider.onClose();
                 provider.configuration.onClose({ event });
@@ -1703,7 +1703,8 @@ class MessageReceiver {
                 throw new Error(`Can’t apply message of unknown type: ${type}`);
         }
         // Reply
-        if (message.length() > emptyMessageLength + 1) { // length of documentName (considered in emptyMessageLength plus length of yjs sync type, set in applySyncMessage)
+        if (message.length() > emptyMessageLength + 1) {
+            // length of documentName (considered in emptyMessageLength plus length of yjs sync type, set in applySyncMessage)
             // @ts-ignore
             provider.send(OutgoingMessage, { encoder: message.encoder });
         }
@@ -1759,11 +1760,11 @@ class AuthenticationMessage extends OutgoingMessage {
     constructor() {
         super(...arguments);
         this.type = MessageType.Auth;
-        this.description = 'Authentication';
+        this.description = "Authentication";
     }
     get(args) {
-        if (typeof args.token === 'undefined') {
-            throw new Error('The authentication message requires `token` as an argument.');
+        if (typeof args.token === "undefined") {
+            throw new Error("The authentication message requires `token` as an argument.");
         }
         writeVarString(this.encoder, args.documentName);
         writeVarUint(this.encoder, this.type);
@@ -1776,14 +1777,14 @@ class AwarenessMessage extends OutgoingMessage {
     constructor() {
         super(...arguments);
         this.type = MessageType.Awareness;
-        this.description = 'Awareness states update';
+        this.description = "Awareness states update";
     }
     get(args) {
-        if (typeof args.awareness === 'undefined') {
-            throw new Error('The awareness message requires awareness as an argument');
+        if (typeof args.awareness === "undefined") {
+            throw new Error("The awareness message requires awareness as an argument");
         }
-        if (typeof args.clients === 'undefined') {
-            throw new Error('The awareness message requires clients as an argument');
+        if (typeof args.clients === "undefined") {
+            throw new Error("The awareness message requires clients as an argument");
         }
         writeVarString(this.encoder, args.documentName);
         writeVarUint(this.encoder, this.type);
@@ -1803,13 +1804,13 @@ class StatelessMessage extends OutgoingMessage {
     constructor() {
         super(...arguments);
         this.type = MessageType.Stateless;
-        this.description = 'A stateless message';
+        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 : '');
+        writeVarString(this.encoder, (_a = args.payload) !== null && _a !== void 0 ? _a : "");
         return this.encoder;
     }
 }
@@ -1818,11 +1819,11 @@ class SyncStepOneMessage extends OutgoingMessage {
     constructor() {
         super(...arguments);
         this.type = MessageType.Sync;
-        this.description = 'First sync step';
+        this.description = "First sync step";
     }
     get(args) {
-        if (typeof args.document === 'undefined') {
-            throw new Error('The sync step one message requires document as an argument');
+        if (typeof args.document === "undefined") {
+            throw new Error("The sync step one message requires document as an argument");
         }
         writeVarString(this.encoder, args.documentName);
         writeVarUint(this.encoder, this.type);
@@ -1835,7 +1836,7 @@ class UpdateMessage extends OutgoingMessage {
     constructor() {
         super(...arguments);
         this.type = MessageType.Sync;
-        this.description = 'A document update';
+        this.description = "A document update";
     }
     get(args) {
         writeVarString(this.encoder, args.documentName);
@@ -1856,7 +1857,7 @@ class HocuspocusProvider extends EventEmitter {
         var _a, _b, _c;
         super();
         this.configuration = {
-            name: '',
+            name: "",
             // @ts-ignore
             document: undefined,
             // @ts-ignore
@@ -1893,35 +1894,44 @@ class HocuspocusProvider extends EventEmitter {
         this.boundPageHide = this.pageHide.bind(this);
         this.boundOnOpen = this.onOpen.bind(this);
         this.boundOnClose = this.onClose.bind(this);
-        this.forwardConnect = (e) => this.emit('connect', e);
-        this.forwardClose = (e) => this.emit('close', e);
-        this.forwardDisconnect = (e) => this.emit('disconnect', e);
-        this.forwardDestroy = (e) => this.emit('destroy', e);
+        this.forwardConnect = (e) => this.emit("connect", e);
+        this.forwardClose = (e) => this.emit("close", e);
+        this.forwardDisconnect = (e) => this.emit("disconnect", e);
+        this.forwardDestroy = (e) => this.emit("destroy", e);
         this.setConfiguration(configuration);
-        this.configuration.document = configuration.document ? configuration.document : new Y.Doc();
-        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);
-        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('stateless', this.configuration.onStateless);
-        this.on('unsyncedChanges', this.configuration.onUnsyncedChanges);
-        this.on('authenticated', this.configuration.onAuthenticated);
-        this.on('authenticationFailed', this.configuration.onAuthenticationFailed);
-        (_a = this.awareness) === null || _a === void 0 ? void 0 : _a.on('update', () => {
-            this.emit('awarenessUpdate', { states: awarenessStatesToArray(this.awareness.getStates()) });
+        this.configuration.document = configuration.document
+            ? configuration.document
+            : new Y.Doc();
+        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);
+        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("stateless", this.configuration.onStateless);
+        this.on("unsyncedChanges", this.configuration.onUnsyncedChanges);
+        this.on("authenticated", this.configuration.onAuthenticated);
+        this.on("authenticationFailed", this.configuration.onAuthenticationFailed);
+        (_a = this.awareness) === null || _a === void 0 ? void 0 : _a.on("update", () => {
+            this.emit("awarenessUpdate", {
+                states: awarenessStatesToArray(this.awareness.getStates()),
+            });
         });
-        (_b = this.awareness) === null || _b === void 0 ? void 0 : _b.on('change', () => {
-            this.emit('awarenessChange', { states: awarenessStatesToArray(this.awareness.getStates()) });
+        (_b = this.awareness) === null || _b === void 0 ? void 0 : _b.on("change", () => {
+            this.emit("awarenessChange", {
+                states: awarenessStatesToArray(this.awareness.getStates()),
+            });
         });
-        this.document.on('update', this.boundDocumentUpdateHandler);
-        (_c = this.awareness) === null || _c === void 0 ? void 0 : _c.on('update', this.boundAwarenessUpdateHandler);
+        this.document.on("update", this.boundDocumentUpdateHandler);
+        (_c = this.awareness) === null || _c === void 0 ? void 0 : _c.on("update", this.boundAwarenessUpdateHandler);
         this.registerEventListeners();
-        if (this.configuration.forceSyncInterval
-            && typeof this.configuration.forceSyncInterval === 'number') {
+        if (this.configuration.forceSyncInterval &&
+            typeof this.configuration.forceSyncInterval === "number") {
             this.intervals.forceSync = setInterval(this.forceSync.bind(this), this.configuration.forceSyncInterval);
         }
         if (this.manageSocket) {
@@ -1952,11 +1962,11 @@ class HocuspocusProvider extends EventEmitter {
     }
     resetUnsyncedChanges() {
         this.unsyncedChanges = 1;
-        this.emit('unsyncedChanges', { number: this.unsyncedChanges });
+        this.emit("unsyncedChanges", { number: this.unsyncedChanges });
     }
     incrementUnsyncedChanges() {
         this.unsyncedChanges += 1;
-        this.emit('unsyncedChanges', { number: this.unsyncedChanges });
+        this.emit("unsyncedChanges", { number: this.unsyncedChanges });
     }
     decrementUnsyncedChanges() {
         if (this.unsyncedChanges > 0) {
@@ -1965,25 +1975,31 @@ class HocuspocusProvider extends EventEmitter {
         if (this.unsyncedChanges === 0) {
             this.synced = true;
         }
-        this.emit('unsyncedChanges', { number: this.unsyncedChanges });
+        this.emit("unsyncedChanges", { number: this.unsyncedChanges });
     }
     forceSync() {
         this.resetUnsyncedChanges();
-        this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
+        this.send(SyncStepOneMessage, {
+            document: this.document,
+            documentName: this.configuration.name,
+        });
     }
     pageHide() {
         if (this.awareness) {
-            removeAwarenessStates(this.awareness, [this.document.clientID], 'page hide');
+            removeAwarenessStates(this.awareness, [this.document.clientID], "page hide");
         }
     }
     registerEventListeners() {
-        if (typeof window === 'undefined' || !('addEventListener' in window)) {
+        if (typeof window === "undefined" || !("addEventListener" in window)) {
             return;
         }
-        window.addEventListener('pagehide', this.boundPageHide);
+        window.addEventListener("pagehide", this.boundPageHide);
     }
     sendStateless(payload) {
-        this.send(StatelessMessage, { documentName: this.configuration.name, payload });
+        this.send(StatelessMessage, {
+            documentName: this.configuration.name,
+            payload,
+        });
     }
     documentUpdateHandler(update, origin) {
         if (origin === this) {
@@ -2015,28 +2031,28 @@ class HocuspocusProvider extends EventEmitter {
         }
         this.isSynced = state;
         if (state) {
-            this.emit('synced', { state });
+            this.emit("synced", { state });
         }
     }
     receiveStateless(payload) {
-        this.emit('stateless', { payload });
+        this.emit("stateless", { payload });
     }
     // not needed, but provides backward compatibility with e.g. lexical/yjs
     async connect() {
         if (this.manageSocket) {
             return this.configuration.websocketProvider.connect();
         }
-        console.warn('HocuspocusProvider::connect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.');
+        console.warn("HocuspocusProvider::connect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.");
     }
     disconnect() {
         if (this.manageSocket) {
             return this.configuration.websocketProvider.disconnect();
         }
-        console.warn('HocuspocusProvider::disconnect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.');
+        console.warn("HocuspocusProvider::disconnect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.");
     }
     async onOpen(event) {
         this.isAuthenticated = false;
-        this.emit('open', { event });
+        this.emit("open", { event });
         let token;
         try {
             token = await this.getToken();
@@ -2046,13 +2062,13 @@ class HocuspocusProvider extends EventEmitter {
             return;
         }
         this.send(AuthenticationMessage, {
-            token: token !== null && token !== void 0 ? token : '',
+            token: token !== null && token !== void 0 ? token : "",
             documentName: this.configuration.name,
         });
         this.startSync();
     }
     async getToken() {
-        if (typeof this.configuration.token === 'function') {
+        if (typeof this.configuration.token === "function") {
             const token = await this.configuration.token();
             return token;
         }
@@ -2060,7 +2076,10 @@ class HocuspocusProvider extends EventEmitter {
     }
     startSync() {
         this.resetUnsyncedChanges();
-        this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name });
+        this.send(SyncStepOneMessage, {
+            document: this.document,
+            documentName: this.configuration.name,
+        });
         if (this.awareness && this.awareness.getLocalState() !== null) {
             this.send(AwarenessMessage, {
                 awareness: this.awareness,
@@ -2073,14 +2092,14 @@ class HocuspocusProvider extends EventEmitter {
         if (!this._isAttached)
             return;
         const messageSender = new MessageSender(message, args);
-        this.emit('outgoingMessage', { message: messageSender.message });
+        this.emit("outgoingMessage", { message: messageSender.message });
         messageSender.send(this.configuration.websocketProvider);
     }
     onMessage(event) {
         const message = new IncomingMessage(event.data);
         const documentName = message.readVarString();
         message.writeVarString(documentName);
-        this.emit('message', { event, message: new IncomingMessage(event.data) });
+        this.emit("message", { event, message: new IncomingMessage(event.data) });
         new MessageReceiver(message).apply(this, true);
     }
     onClose() {
@@ -2088,68 +2107,68 @@ class HocuspocusProvider extends EventEmitter {
         this.synced = false;
         // update awareness (all users except local left)
         if (this.awareness) {
-            removeAwarenessStates(this.awareness, Array.from(this.awareness.getStates().keys()).filter(client => client !== this.document.clientID), this);
+            removeAwarenessStates(this.awareness, Array.from(this.awareness.getStates().keys()).filter((client) => client !== this.document.clientID), this);
         }
     }
     destroy() {
-        this.emit('destroy');
+        this.emit("destroy");
         if (this.intervals.forceSync) {
             clearInterval(this.intervals.forceSync);
         }
         if (this.awareness) {
-            removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy');
-            this.awareness.off('update', this.boundAwarenessUpdateHandler);
+            removeAwarenessStates(this.awareness, [this.document.clientID], "provider destroy");
+            this.awareness.off("update", this.boundAwarenessUpdateHandler);
             this.awareness.destroy();
         }
-        this.document.off('update', this.boundDocumentUpdateHandler);
+        this.document.off("update", this.boundDocumentUpdateHandler);
         this.removeAllListeners();
         this.detach();
         if (this.manageSocket) {
             this.configuration.websocketProvider.destroy();
         }
-        if (typeof window === 'undefined' || !('removeEventListener' in window)) {
+        if (typeof window === "undefined" || !("removeEventListener" in window)) {
             return;
         }
-        window.removeEventListener('pagehide', this.boundPageHide);
+        window.removeEventListener("pagehide", this.boundPageHide);
     }
     detach() {
-        this.configuration.websocketProvider.off('connect', this.configuration.onConnect);
-        this.configuration.websocketProvider.off('connect', this.forwardConnect);
-        this.configuration.websocketProvider.off('open', this.boundOnOpen);
-        this.configuration.websocketProvider.off('close', this.boundOnClose);
-        this.configuration.websocketProvider.off('close', this.configuration.onClose);
-        this.configuration.websocketProvider.off('close', this.forwardClose);
-        this.configuration.websocketProvider.off('disconnect', this.configuration.onDisconnect);
-        this.configuration.websocketProvider.off('disconnect', this.forwardDisconnect);
-        this.configuration.websocketProvider.off('destroy', this.configuration.onDestroy);
-        this.configuration.websocketProvider.off('destroy', this.forwardDestroy);
+        this.configuration.websocketProvider.off("connect", this.configuration.onConnect);
+        this.configuration.websocketProvider.off("connect", this.forwardConnect);
+        this.configuration.websocketProvider.off("open", this.boundOnOpen);
+        this.configuration.websocketProvider.off("close", this.boundOnClose);
+        this.configuration.websocketProvider.off("close", this.configuration.onClose);
+        this.configuration.websocketProvider.off("close", this.forwardClose);
+        this.configuration.websocketProvider.off("disconnect", this.configuration.onDisconnect);
+        this.configuration.websocketProvider.off("disconnect", this.forwardDisconnect);
+        this.configuration.websocketProvider.off("destroy", this.configuration.onDestroy);
+        this.configuration.websocketProvider.off("destroy", this.forwardDestroy);
         this.configuration.websocketProvider.detach(this);
         this._isAttached = false;
     }
     attach() {
         if (this._isAttached)
             return;
-        this.configuration.websocketProvider.on('connect', this.configuration.onConnect);
-        this.configuration.websocketProvider.on('connect', this.forwardConnect);
-        this.configuration.websocketProvider.on('open', this.boundOnOpen);
-        this.configuration.websocketProvider.on('close', this.boundOnClose);
-        this.configuration.websocketProvider.on('close', this.configuration.onClose);
-        this.configuration.websocketProvider.on('close', this.forwardClose);
-        this.configuration.websocketProvider.on('disconnect', this.configuration.onDisconnect);
-        this.configuration.websocketProvider.on('disconnect', this.forwardDisconnect);
-        this.configuration.websocketProvider.on('destroy', this.configuration.onDestroy);
-        this.configuration.websocketProvider.on('destroy', this.forwardDestroy);
+        this.configuration.websocketProvider.on("connect", this.configuration.onConnect);
+        this.configuration.websocketProvider.on("connect", this.forwardConnect);
+        this.configuration.websocketProvider.on("open", this.boundOnOpen);
+        this.configuration.websocketProvider.on("close", this.boundOnClose);
+        this.configuration.websocketProvider.on("close", this.configuration.onClose);
+        this.configuration.websocketProvider.on("close", this.forwardClose);
+        this.configuration.websocketProvider.on("disconnect", this.configuration.onDisconnect);
+        this.configuration.websocketProvider.on("disconnect", this.forwardDisconnect);
+        this.configuration.websocketProvider.on("destroy", this.configuration.onDestroy);
+        this.configuration.websocketProvider.on("destroy", this.forwardDestroy);
         this.configuration.websocketProvider.attach(this);
         this._isAttached = true;
     }
     permissionDeniedHandler(reason) {
-        this.emit('authenticationFailed', { reason });
+        this.emit("authenticationFailed", { reason });
         this.isAuthenticated = false;
     }
     authenticatedHandler(scope) {
         this.isAuthenticated = true;
         this.authorizedScope = scope;
-        this.emit('authenticated', { scope });
+        this.emit("authenticated", { scope });
     }
     setAwarenessField(key, value) {
         if (!this.awareness) {