@hocuspocus/provider 2.12.3 → 2.13.1

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

@@ -89,7 +89,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     isConnected: boolean;
     constructor(configuration: HocuspocusProviderConfiguration);
     boundBroadcastChannelSubscriber: (data: ArrayBuffer) => void;
-    boundPageUnload: () => void;
+    boundPageHide: () => void;
     boundOnOpen: (event: Event) => Promise<void>;
     boundOnClose: (event: CloseEvent) => void;
     boundOnStatus: ({ status }: onStatusParameters) => void;
@@ -103,10 +103,11 @@ export declare class HocuspocusProvider extends EventEmitter {
     get document(): Y.Doc;
     get awareness(): Awareness | null;
     get hasUnsyncedChanges(): boolean;
+    private resetUnsyncedChanges;
     incrementUnsyncedChanges(): void;
     decrementUnsyncedChanges(): void;
     forceSync(): void;
-    pageUnload(): void;
+    pageHide(): void;
     registerEventListeners(): void;
     sendStateless(payload: string): void;
     documentUpdateHandler(update: Uint8Array, origin: any): void;

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

@@ -26,6 +26,7 @@ export declare const defaultConfiguration: {
  */
 export declare class Hocuspocus {
     configuration: Configuration;
+    loadingDocuments: Map<string, Promise<Document>>;
     documents: Map<string, Document>;
     server?: HocuspocusServer;
     debugger: Debugger;
@@ -87,6 +88,7 @@ export declare class Hocuspocus {
      * Create a new document by the given request
      */
     createDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
+    loadDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
     storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload): Promise<void>;
     /**
      * Run the given hook on all configured extensions.

package/package.json

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

package/src/HocuspocusProvider.ts

@@ -231,7 +231,7 @@ export class HocuspocusProvider extends EventEmitter {
 
   boundBroadcastChannelSubscriber = this.broadcastChannelSubscriber.bind(this)
 
-  boundPageUnload = this.pageUnload.bind(this)
+  boundPageHide = this.pageHide.bind(this)
 
   boundOnOpen = this.onOpen.bind(this)
 
@@ -282,6 +282,11 @@ export class HocuspocusProvider extends EventEmitter {
     return this.unsyncedChanges > 0
   }
 
+  private resetUnsyncedChanges() {
+    this.unsyncedChanges = 1
+    this.emit('unsyncedChanges', this.unsyncedChanges)
+  }
+
   incrementUnsyncedChanges() {
     this.unsyncedChanges += 1
     this.emit('unsyncedChanges', this.unsyncedChanges)
@@ -296,12 +301,14 @@ export class HocuspocusProvider extends EventEmitter {
   }
 
   forceSync() {
+    this.resetUnsyncedChanges()
+
     this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name })
   }
 
-  pageUnload() {
+  pageHide() {
     if (this.awareness) {
-      removeAwarenessStates(this.awareness, [this.document.clientID], 'window unload')
+      removeAwarenessStates(this.awareness, [this.document.clientID], 'page hide')
     }
   }
 
@@ -310,7 +317,7 @@ export class HocuspocusProvider extends EventEmitter {
       return
     }
 
-    window.addEventListener('unload', this.boundPageUnload)
+    window.addEventListener('pagehide', this.boundPageHide)
   }
 
   sendStateless(payload: string) {
@@ -364,7 +371,7 @@ export class HocuspocusProvider extends EventEmitter {
     return !!this.configuration.token && !this.isAuthenticated
   }
 
-  // not needed, but provides backward compatibility with e.g. lexicla/yjs
+  // not needed, but provides backward compatibility with e.g. lexical/yjs
   async connect() {
     if (this.configuration.broadcast) {
       this.subscribeToBroadcastChannel()
@@ -420,7 +427,8 @@ export class HocuspocusProvider extends EventEmitter {
   }
 
   startSync() {
-    this.incrementUnsyncedChanges()
+    this.resetUnsyncedChanges()
+
     this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name })
 
     if (this.awareness && this.awareness.getLocalState() !== null) {
@@ -510,7 +518,7 @@ export class HocuspocusProvider extends EventEmitter {
       return
     }
 
-    window.removeEventListener('unload', this.boundPageUnload)
+    window.removeEventListener('pagehide', this.boundPageHide)
   }
 
   permissionDeniedHandler(reason: string) {