@hocuspocus/provider 2.7.1 → 2.8.0

package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts

@@ -1,4 +1,3 @@
-import * as mutex from 'lib0/mutex';
 import type { MessageEvent } from 'ws';
 import { Event } from 'ws';
 import EventEmitter from './EventEmitter.js';
@@ -85,7 +84,6 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
 export declare class HocuspocusProviderWebsocket extends EventEmitter {
     private messageQueue;
     configuration: CompleteHocuspocusProviderWebsocketConfiguration;
-    subscribedToBroadcastChannel: boolean;
     webSocket: HocusPocusWebSocket | null;
     webSocketHandlers: {
         [key: string]: any;
@@ -94,7 +92,6 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     status: WebSocketStatus;
     lastMessageReceived: number;
     identifier: number;
-    mux: mutex.mutex;
     intervals: any;
     connectionAttempt: {
         resolve: (value?: any) => void;
@@ -108,7 +105,6 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     attach(provider: HocuspocusProvider): void;
     detach(provider: HocuspocusProvider): void;
     setConfiguration(configuration?: Partial<HocuspocusProviderWebsocketConfiguration>): void;
-    boundConnect: () => Promise<unknown>;
     cancelWebsocketRetry?: () => void;
     connect(): Promise<unknown>;
     attachWebSocketListeners(ws: HocusPocusWebSocket, reject: Function): void;

package/dist/packages/server/src/Hocuspocus.d.ts

@@ -19,6 +19,7 @@ export declare const defaultConfiguration: {
         gcFilter: () => boolean;
     };
     unloadImmediately: boolean;
+    stopOnSignals: boolean;
 };
 /**
  * Hocuspocus Server
@@ -28,7 +29,7 @@ export declare class Hocuspocus {
     documents: Map<string, Document>;
     server?: HocuspocusServer;
     debugger: Debugger;
-    debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => void;
+    debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => any;
     constructor(configuration?: Partial<Configuration>);
     /**
      * Configure the server

package/dist/packages/server/src/types.d.ts

@@ -116,6 +116,12 @@ export interface Configuration extends Extension {
      * your onStoreDocument is rate-limited.
      */
     unloadImmediately: boolean;
+    /**
+     * the server will gracefully stop if SIGINT, SIGQUIT or SIGTERM is received.
+     *
+     * Set this to false if you don't want that.
+     */
+    stopOnSignals: boolean;
     /**
      * options to pass to the ydoc document
      */

package/dist/packages/server/src/util/debounce.d.ts

@@ -1 +1 @@
-export declare const useDebounce: () => (id: string, func: Function, debounce: number, maxDebounce: number) => void;
+export declare const useDebounce: () => (id: string, func: Function, debounce: number, maxDebounce: number) => any;

package/dist/tests/server/afterLoadDocument.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "2.7.1",
+  "version": "2.8.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^2.7.1",
+    "@hocuspocus/common": "^2.8.0",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.47",
     "ws": "^8.14.2"

package/src/HocuspocusProvider.ts

@@ -373,13 +373,17 @@ export class HocuspocusProvider extends EventEmitter {
   disconnect() {
     this.disconnectBroadcastChannel()
     this.configuration.websocketProvider.detach(this)
+    this.isConnected = false
+
     if (!this.configuration.preserveConnection) {
       this.configuration.websocketProvider.disconnect()
     }
+
   }
 
   async onOpen(event: Event) {
     this.isAuthenticated = false
+    this.isConnected = true
 
     this.emit('open', { event })
 
@@ -475,8 +479,6 @@ export class HocuspocusProvider extends EventEmitter {
       removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy')
     }
 
-    this.disconnect()
-
     this.awareness?.off('update', this.awarenessUpdateHandler)
     this.document.off('update', this.documentUpdateHandler)
 
@@ -496,7 +498,7 @@ export class HocuspocusProvider extends EventEmitter {
     this.configuration.websocketProvider.off('destroy', this.forwardDestroy)
 
     this.send(CloseMessage, { documentName: this.configuration.name })
-    this.isConnected = false
+    this.disconnect()
 
     if (typeof window === 'undefined') {
       return

package/src/HocuspocusProviderWebsocket.ts

@@ -2,7 +2,6 @@ import {
   Forbidden, MessageTooBig, Unauthorized, WsReadyStates,
 } from '@hocuspocus/common'
 import { retry } from '@lifeomic/attempt'
-import * as mutex from 'lib0/mutex'
 import * as time from 'lib0/time'
 import * as url from 'lib0/url'
 import type { MessageEvent } from 'ws'
@@ -143,8 +142,6 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     providerMap: new Map(),
   }
 
-  subscribedToBroadcastChannel = false
-
   webSocket: HocusPocusWebSocket | null = null
 
   webSocketHandlers: { [key: string]: any } = {}
@@ -157,8 +154,6 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 
   identifier = 0
 
-  mux = mutex.createMutex()
-
   intervals: any = {
     forceSync: null,
     connectionChecker: null,
@@ -247,8 +242,6 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     this.configuration = { ...this.configuration, ...configuration }
   }
 
-  boundConnect = this.connect.bind(this)
-
   cancelWebsocketRetry?: () => void
 
   async connect() {