@hocuspocus/extension-throttle 2.4.0 → 2.5.0-rc.0

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

@@ -19,6 +19,7 @@ export declare const defaultConfiguration: {
         gc: boolean;
         gcFilter: () => boolean;
     };
+    unloadImmediately: boolean;
 };
 /**
  * Hocuspocus Server
@@ -72,6 +73,9 @@ export declare class Hocuspocus {
     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/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-throttle",
-  "version": "2.4.0",
+  "version": "2.5.0-rc.0",
   "description": "hocuspocus throttle extension",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,7 +28,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^2.4.0"
+    "@hocuspocus/server": "^2.5.0-rc.0"
   },
   "gitHead": "b3454a4ca289a84ddfb7fa5607a2d4b8d5c37e9d"
 }