@hocuspocus/extension-redis 2.4.0-rc.1 → 2.5.0-rc.0

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

@@ -25,7 +25,6 @@ export declare class Connection {
      */
     constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly: boolean | undefined, logger: Debugger);
     boundClose: (event?: CloseEvent) => void;
-    boundHandleMessage: (data: Uint8Array) => void;
     boundHandlePong: () => void;
     handlePong(): void;
     /**
@@ -64,8 +63,8 @@ export declare class Connection {
     private sendCurrentAwareness;
     /**
      * Handle an incoming message
-     * @private
+     * @public
      */
-    private handleMessage;
+    handleMessage(data: Uint8Array): void;
 }
 export default Connection;

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

@@ -9,6 +9,6 @@ export declare class DirectConnection implements DirectConnectionInterface {
      * Constructor.
      */
     constructor(document: Document, instance: Hocuspocus, context?: any);
-    transact(transaction: (document: Document) => void): Promise<void>;
+    transact(transaction: (document: Document) => void, transactionOrigin?: any): Promise<void>;
     disconnect(): void;
 }

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

@@ -1,7 +1,8 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { Server as HTTPServer, IncomingMessage } from 'http';
-import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
+import { IncomingMessage } from 'http';
+import WebSocket, { AddressInfo } from 'ws';
+import { Server as HocuspocusServer } from './Server';
 import { Debugger } from './Debugger.js';
 import { DirectConnection } from './DirectConnection.js';
 import Document from './Document.js';
@@ -18,6 +19,7 @@ export declare const defaultConfiguration: {
         gc: boolean;
         gcFilter: () => boolean;
     };
+    unloadImmediately: boolean;
 };
 /**
  * Hocuspocus Server
@@ -25,8 +27,7 @@ export declare const defaultConfiguration: {
 export declare class Hocuspocus {
     configuration: Configuration;
     documents: Map<string, Document>;
-    httpServer?: HTTPServer;
-    webSocketServer?: WebSocketServer;
+    server?: HocuspocusServer;
     debugger: Debugger;
     constructor(configuration?: Partial<Configuration>);
     /**
@@ -66,12 +67,15 @@ export declare class Hocuspocus {
      *  - onConnect for all connections
      *  - onAuthenticate only if required
      *
-     * … and if nothings fails it’ll fully establish the connection and
+     * … and if nothing fails it’ll fully establish the connection and
      * load the Document then.
      */
     handleConnection(incoming: WebSocket, request: IncomingMessage, defaultContext?: any): void;
     /**
      * Handle update of the given document
+     *
+     * "connection" is not necessarily type "Connection", it's the Yjs "origin" (which is "Connection" if
+     * the update is incoming from the provider, but can be anything if the updates is originated from an extension.
      */
     private handleDocumentUpdate;
     timers: Map<string, {

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

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
+import { WebSocketServer } from 'ws';
+import { Hocuspocus } from './Hocuspocus';
+export declare class Server {
+    httpServer: HTTPServer;
+    webSocketServer: WebSocketServer;
+    hocuspocus: Hocuspocus;
+    constructor(hocuspocus: Hocuspocus);
+    setupWebsocketConnection: () => void;
+    setupHttpUpgrade: () => void;
+    requestHandler: (request: IncomingMessage, response: ServerResponse) => Promise<void>;
+}

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

@@ -108,6 +108,14 @@ export interface Configuration extends Extension {
      * By default, the servers show a start screen. If passed false, the server will start quietly.
      */
     quiet: boolean;
+    /**
+     * If set to false, respects the debounce time of `onStoreDocument` before unloading a document.
+     * Otherwise, the document will be unloaded immediately.
+     *
+     * This prevents a client from DOSing the server by repeatedly connecting and disconnecting when
+     * your onStoreDocument is rate-limited.
+     */
+    unloadImmediately: boolean;
     /**
      * options to pass to the ydoc document
      */
@@ -190,6 +198,7 @@ export interface onChangePayload {
     requestParameters: URLSearchParams;
     update: Uint8Array;
     socketId: string;
+    transactionOrigin: any;
 }
 export interface beforeHandleMessagePayload {
     clientsCount: number;
@@ -217,6 +226,7 @@ export interface onStoreDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
+    transactionOrigin?: any;
 }
 export interface afterStoreDocumentPayload extends onStoreDocumentPayload {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-redis",
-  "version": "2.4.0-rc.1",
+  "version": "2.5.0-rc.0",
   "description": "Scale Hocuspocus horizontally with Redis",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -33,7 +33,7 @@
     "@types/redlock": "^4.0.3"
   },
   "dependencies": {
-    "@hocuspocus/server": "^2.4.0-rc.1",
+    "@hocuspocus/server": "^2.5.0-rc.0",
     "ioredis": "^4.28.2",
     "kleur": "^4.1.4",
     "lodash.debounce": "^4.0.8",