@hocuspocus/provider 2.0.2 → 2.0.4

package/dist/packages/common/src/CloseEvents.d.ts

@@ -2,6 +2,12 @@ export interface CloseEvent {
     code: number;
     reason: string;
 }
+/**
+ * The server is terminating the connection because a data frame was received
+ * that is too large.
+ * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
+ */
+export declare const MessageTooBig: CloseEvent;
 /**
  * The server successfully processed the request, asks that the requester reset
  * its document view, and is not returning any content.

package/dist/packages/extension-redis/src/Redis.d.ts

@@ -42,6 +42,11 @@ export interface Configuration {
      * The maximum time for the Redis lock in ms (in case it can’t be released).
      */
     lockTimeout: number;
+    /**
+     * A delay before onDisconnect is executed. This allows last minute updates'
+     * sync messages to be received by the subscription before it's closed.
+     */
+    disconnectDelay: number;
 }
 export declare class Redis implements Extension {
     /**
@@ -103,7 +108,7 @@ export declare class Redis implements Extension {
      * Make sure to *not* listen for further changes, when there’s
      * noone connected anymore.
      */
-    onDisconnect: ({ documentName, clientsCount }: onDisconnectPayload) => Promise<void>;
+    onDisconnect: ({ document, documentName }: onDisconnectPayload) => Promise<void>;
     beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
     /**
      * Kill the Redlock connection immediately.

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

@@ -77,6 +77,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     get document(): Y.Doc;
     get awareness(): Awareness;
     get hasUnsyncedChanges(): boolean;
+    updateUnsyncedChanges(unsyncedChanges?: number): void;
     forceSync(): void;
     boundBeforeUnload: () => void;
     beforeUnload(): void;

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

@@ -0,0 +1,11 @@
+import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket';
+export type TiptapCollabProviderWebsocketConfiguration = Partial<CompleteHocuspocusProviderWebsocketConfiguration> & AdditionalTiptapCollabProviderWebsocketConfiguration;
+export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
+    /**
+     * A Hocuspocus Cloud App ID, get one here: https://collab.tiptap.dev
+     */
+    appId: string;
+}
+export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
+    constructor(configuration: TiptapCollabProviderWebsocketConfiguration);
+}

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

@@ -1,4 +1,5 @@
 export * from './HocuspocusProvider';
 export * from './TiptapCollabProvider';
+export * from './TiptapCollabProviderWebsocket';
 export * from './HocuspocusProviderWebsocket';
 export * from './types';

package/package.json

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

package/src/HocuspocusProvider.ts

@@ -232,10 +232,15 @@ export class HocuspocusProvider extends EventEmitter {
     return this.configuration.awareness
   }
 
-  get hasUnsyncedChanges() {
+  get hasUnsyncedChanges(): boolean {
     return this.unsyncedChanges > 0
   }
 
+  updateUnsyncedChanges(unsyncedChanges = 0) {
+    this.unsyncedChanges += unsyncedChanges
+    this.emit('unsyncedChanges', this.unsyncedChanges)
+  }
+
   forceSync() {
     this.send(SyncStepOneMessage, { document: this.document, documentName: this.configuration.name })
   }
@@ -263,7 +268,7 @@ export class HocuspocusProvider extends EventEmitter {
       return
     }
 
-    this.unsyncedChanges += 1
+    this.updateUnsyncedChanges(1)
     this.send(UpdateMessage, { update, documentName: this.configuration.name }, true)
   }
 
@@ -286,6 +291,10 @@ export class HocuspocusProvider extends EventEmitter {
       return
     }
 
+    if (state && this.unsyncedChanges > 0) {
+      this.updateUnsyncedChanges(-1 * this.unsyncedChanges)
+    }
+
     this.isSynced = state
     this.emit('synced', { state })
     this.emit('sync', { state })
@@ -310,6 +319,8 @@ export class HocuspocusProvider extends EventEmitter {
   }
 
   async onOpen(event: Event) {
+    this.isAuthenticated = false
+
     this.emit('open', { event })
 
     if (this.isAuthenticationRequired) {

package/src/HocuspocusProviderWebsocket.ts

@@ -4,7 +4,7 @@ import * as url from 'lib0/url'
 import type { MessageEvent } from 'ws'
 import { retry } from '@lifeomic/attempt'
 import {
-  Forbidden, Unauthorized, WsReadyStates,
+  Forbidden, MessageTooBig, Unauthorized, WsReadyStates,
 } from '@hocuspocus/common'
 import { Event } from 'ws'
 import EventEmitter from './EventEmitter'
@@ -425,6 +425,11 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
       }
     }
 
+    if (event.code === MessageTooBig.code) {
+      console.warn(`[HocuspocusProvider] Connection closed with status MessageTooBig: ${event.reason}`)
+      this.shouldConnect = false
+    }
+
     if (this.connectionAttempt) {
       // That connection attempt failed.
       this.rejectConnectionAttempt()

package/src/MessageReceiver.ts

@@ -88,7 +88,7 @@ export class MessageReceiver {
 
     if (syncMessageType === messageYjsUpdate || syncMessageType === messageYjsSyncStep2) {
       if (provider.unsyncedChanges > 0) {
-        provider.unsyncedChanges -= 1
+        provider.updateUnsyncedChanges(-1)
       }
     }
   }

package/src/TiptapCollabProvider.ts

@@ -2,9 +2,8 @@ import {
   HocuspocusProvider,
   HocuspocusProviderConfiguration,
 } from './HocuspocusProvider'
-import {
-  HocuspocusProviderWebsocket,
-} from './HocuspocusProviderWebsocket'
+
+import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket'
 
 export type TiptapCollabProviderConfiguration =
   Required<Pick<HocuspocusProviderConfiguration, 'name'>> &
@@ -21,11 +20,11 @@ export interface AdditionalTiptapCollabProviderConfiguration {
 export class TiptapCollabProvider extends HocuspocusProvider {
   constructor(configuration: TiptapCollabProviderConfiguration) {
     if (!configuration.websocketProvider) {
-      configuration.websocketProvider = new HocuspocusProviderWebsocket({ url: `wss://${configuration.appId}.collab.tiptap.cloud` })
+      configuration.websocketProvider = new TiptapCollabProviderWebsocket({ appId: configuration.appId })
     }
 
     if (!configuration.token) {
-      configuration.token = 'notoken'
+      configuration.token = 'notoken' // need to send a token anyway (which will be ignored)
     }
 
     super(configuration as HocuspocusProviderConfiguration)

package/src/TiptapCollabProviderWebsocket.ts

@@ -0,0 +1,21 @@
+import {
+  CompleteHocuspocusProviderWebsocketConfiguration,
+  HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration,
+} from './HocuspocusProviderWebsocket'
+
+export type TiptapCollabProviderWebsocketConfiguration =
+  Partial<CompleteHocuspocusProviderWebsocketConfiguration> &
+  AdditionalTiptapCollabProviderWebsocketConfiguration
+
+export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
+  /**
+   * A Hocuspocus Cloud App ID, get one here: https://collab.tiptap.dev
+   */
+  appId: string,
+}
+
+export class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
+  constructor(configuration: TiptapCollabProviderWebsocketConfiguration) {
+    super({ ...configuration as HocuspocusProviderWebsocketConfiguration, url: `wss://${configuration.appId}.collab.tiptap.cloud` })
+  }
+}

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './HocuspocusProvider'
 export * from './TiptapCollabProvider'
+export * from './TiptapCollabProviderWebsocket'
 export * from './HocuspocusProviderWebsocket'
 export * from './types'

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

@@ -1,12 +0,0 @@
-import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
-import { HocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket';
-export type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> & AdditionalHocuspocusCloudProviderConfiguration;
-export interface AdditionalHocuspocusCloudProviderConfiguration {
-    /**
-     * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
-     */
-    key: string;
-}
-export declare class HocuspocusCloudProvider extends HocuspocusProvider {
-    constructor(configuration: HocuspocusCloudProviderConfiguration);
-}

package/src/HocuspocusCloudProvider.ts

@@ -1,41 +0,0 @@
-import {
-  HocuspocusProvider,
-  HocuspocusProviderConfiguration,
-} from './HocuspocusProvider'
-import {
-  HocuspocusProviderWebsocket,
-  HocuspocusProviderWebsocketConfiguration,
-} from './HocuspocusProviderWebsocket'
-
-export type HocuspocusCloudProviderConfiguration =
-  Required<Pick<HocuspocusProviderConfiguration, 'name'>> &
-  Partial<HocuspocusProviderConfiguration> &
-  Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> &
-AdditionalHocuspocusCloudProviderConfiguration
-
-export interface AdditionalHocuspocusCloudProviderConfiguration {
-  /**
-   * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
-   */
-  key: string,
-}
-
-export class HocuspocusCloudProvider extends HocuspocusProvider {
-  constructor(configuration: HocuspocusCloudProviderConfiguration) {
-    if (!configuration.url) {
-      configuration.url = 'wss://connect.hocuspocus.cloud'
-    }
-
-    if (configuration.key) {
-      if (!configuration.parameters) {
-        configuration.parameters = {}
-      }
-
-      configuration.parameters.key = configuration.key
-    }
-
-    configuration.websocketProvider = new HocuspocusProviderWebsocket({ url: configuration.url })
-
-    super(configuration as HocuspocusProviderConfiguration)
-  }
-}