@hocuspocus/provider 2.0.1 → 2.0.3

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/server/src/Connection.d.ts

@@ -39,7 +39,7 @@ export declare class Connection {
     /**
      * Set a callback that will be triggered before an message is handled
      */
-    beforeHandleMessage(callback: (payload: Document, update: Uint8Array) => Promise<any>): Connection;
+    beforeHandleMessage(callback: (connection: Connection, update: Uint8Array) => Promise<any>): Connection;
     /**
      * Send the given message
      */

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

@@ -176,6 +176,7 @@ export interface beforeHandleMessagePayload {
     requestParameters: URLSearchParams;
     update: Uint8Array;
     socketId: string;
+    connection: Connection;
 }
 export interface beforeBroadcastStatelessPayload {
     document: Document;

package/dist/playground/frontend/src/main.d.ts

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

package/dist/playground/frontend/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfigExport;
+export default _default;

package/package.json

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

package/src/HocuspocusProvider.ts

@@ -213,7 +213,12 @@ export class HocuspocusProvider extends EventEmitter {
 
   public setConfiguration(configuration: Partial<HocuspocusProviderConfiguration> = {}): void {
     if (!configuration.websocketProvider && (configuration as CompleteHocuspocusProviderWebsocketConfiguration).url) {
-      this.configuration.websocketProvider = new HocuspocusProviderWebsocket({ url: (configuration as CompleteHocuspocusProviderWebsocketConfiguration).url })
+      const websocketProviderConfig = configuration as CompleteHocuspocusProviderWebsocketConfiguration
+
+      this.configuration.websocketProvider = new HocuspocusProviderWebsocket({
+        url: websocketProviderConfig.url,
+        parameters: websocketProviderConfig.parameters,
+      })
     }
 
     this.configuration = { ...this.configuration, ...configuration }
@@ -227,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 })
   }
@@ -258,7 +268,7 @@ export class HocuspocusProvider extends EventEmitter {
       return
     }
 
-    this.unsyncedChanges += 1
+    this.updateUnsyncedChanges(1)
     this.send(UpdateMessage, { update, documentName: this.configuration.name }, true)
   }
 
@@ -281,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 })

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/dist/packages/extension-monitor/src/Collector.d.ts

@@ -1,61 +0,0 @@
-/// <reference types="node" />
-import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPayload, onChangePayload } from '@hocuspocus/server';
-export declare class Collector {
-    serverConfiguration: Partial<Configuration>;
-    version: string;
-    connections: {};
-    messages: {};
-    messageCounter: number;
-    memory(): Promise<{
-        free: number;
-        total: number;
-        usage: number;
-    }>;
-    cpu(): Promise<{
-        count: number;
-        model: string;
-        usage: number;
-    }>;
-    connect(data: onConnectPayload): {
-        action: string;
-        documentName: string;
-        socketId: string;
-    };
-    disconnect(data: onDisconnectPayload): {
-        action: string;
-        documentName: string;
-        socketId: string;
-    };
-    connectionCount(): {
-        count: string | number;
-    };
-    createDocument(data: onLoadDocumentPayload): {
-        action: string;
-        document: any;
-        documentName: string;
-        socketId: string;
-    };
-    changeDocument(data: onChangePayload): {
-        action: string;
-        document: any;
-        documentName: string;
-        socketId: string;
-    };
-    messageCount(): {
-        count: number;
-    };
-    documentCount(): {
-        count: number;
-    };
-    documents(): {};
-    info(): Promise<{
-        configuration: Partial<Configuration>;
-        ipAddress: string | null;
-        nodeVersion: string;
-        platform: NodeJS.Platform;
-        started: string;
-        version: string;
-    }>;
-    private getIpAddress;
-    private static readableYDoc;
-}

package/dist/packages/extension-monitor/src/Dashboard.d.ts

@@ -1,30 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import { Socket } from 'net';
-import WebSocket, { WebSocketServer } from 'ws';
-import { Storage } from './Storage';
-export interface Configuration {
-    password: string | undefined;
-    path: string;
-    port: number | undefined;
-    storage: Storage | undefined;
-    user: string | undefined;
-}
-export declare class Dashboard {
-    configuration: Configuration;
-    websocketServer: WebSocketServer;
-    connections: Map<WebSocket, any>;
-    /**
-     * Constructor
-     */
-    constructor(configuration?: Partial<Configuration>);
-    createServer(): void;
-    handleRequest(request: IncomingMessage, response: ServerResponse): boolean;
-    handleUpgrade(request: IncomingMessage, socket: Socket, head: any): boolean;
-    handleConnection(connection: WebSocket, request: IncomingMessage): void;
-    close(connection: WebSocket): void;
-    send(message: string): void;
-    private sendInitialDataToClient;
-    private basicAuth;
-}

package/dist/packages/extension-monitor/src/Storage.d.ts

@@ -1,35 +0,0 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
-export declare class Storage extends EventEmitter {
-    timed: Map<string, any>;
-    constant: Map<string, any>;
-    /**
-     * Get all constant values.
-     */
-    all(): Promise<any>;
-    /**
-     * Get a constant value by the given key.
-     */
-    get(key: string, defaultValue?: any): Promise<any>;
-    /**
-     * Set a constant value by the given key.
-     */
-    set(key: string, value: any): Promise<any>;
-    /**
-     * Delete a constant value by the given key.
-     * @param key
-     */
-    delete(key: string): Promise<any>;
-    /**
-     * Get all timed values.
-     */
-    allTimed(): Promise<any>;
-    /**
-     * Add a timed value by the given key.
-     */
-    add(key: string, value: any): Promise<any>;
-    /**
-     * Remove a timed value by the given timestamp and key.
-     */
-    remove(key: string, timestamp: string): Promise<any>;
-}

package/dist/packages/extension-monitor/src/index.d.ts

@@ -1,38 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import { Extension, onChangePayload, onConfigurePayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload, connectedPayload } from '@hocuspocus/server';
-import WebSocket from 'ws';
-import { Storage } from './Storage';
-import { Dashboard } from './Dashboard';
-import { Collector } from './Collector';
-export interface Configuration {
-    dashboardPath: string;
-    enableDashboard: boolean;
-    metricsInterval: number;
-    osMetricsInterval: number;
-    password: string | undefined;
-    port: number | undefined;
-    user: string | undefined;
-}
-export declare class Monitor implements Extension {
-    configuration: Configuration;
-    storage: Storage;
-    collector: Collector;
-    dashboard?: Dashboard;
-    /**
-     * Constructor
-     */
-    constructor(configuration?: Partial<Configuration>);
-    private collectOsMetrics;
-    private collectConnectionMetrics;
-    private cleanMetrics;
-    handleRequest(request: IncomingMessage, response: ServerResponse): boolean | undefined;
-    handleConnection(websocket: WebSocket, request: IncomingMessage): void | undefined;
-    onRequest({ request, response }: onRequestPayload): Promise<void>;
-    onUpgrade({ request, socket, head }: onUpgradePayload): Promise<void>;
-    connected(data: connectedPayload): Promise<void>;
-    onDisconnect(data: onDisconnectPayload): Promise<void>;
-    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
-    onChange(data: onChangePayload): Promise<void>;
-    onConfigure(data: onConfigurePayload): Promise<void>;
-}