@hocuspocus/extension-database 2.4.0 → 2.5.0

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

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
 import Redlock from 'redlock';
 import { Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, beforeBroadcastStatelessPayload, Hocuspocus } from '@hocuspocus/server';
@@ -56,18 +57,22 @@ export declare class Redis implements Extension {
      */
     priority: number;
     configuration: Configuration;
+    redisTransactionOrigin: string;
     pub: RedisInstance;
     sub: RedisInstance;
     instance: Hocuspocus;
     redlock: Redlock;
     locks: Map<string, Redlock.Lock>;
     logger: Debugger;
+    messagePrefix: Buffer;
     constructor(configuration: Partial<Configuration>);
     onConfigure({ instance }: onConfigurePayload): Promise<void>;
     private getKey;
     private pubKey;
     private subKey;
     private lockKey;
+    private encodeMessage;
+    private decodeMessage;
     /**
      * Once a document is loaded, subscribe to the channel in Redis.
      */
@@ -94,7 +99,7 @@ export declare class Redis implements Extension {
      */
     onAwarenessUpdate({ documentName, awareness, added, updated, removed, }: onAwarenessUpdatePayload): Promise<number>;
     /**
-     * Handle incoming messages published on all subscribed document channels.
+     * Handle incoming messages published on subscribed document channels.
      * Note that this will also include messages from ourselves as it is not possible
      * in Redis to filter these.
     */

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,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { IncomingMessage } from 'http';
 import WebSocket, { AddressInfo } from 'ws';
 import { Server as HocuspocusServer } from './Server';
@@ -19,6 +18,7 @@ export declare const defaultConfiguration: {
         gc: boolean;
         gcFilter: () => boolean;
     };
+    unloadImmediately: boolean;
 };
 /**
  * Hocuspocus Server
@@ -28,6 +28,7 @@ export declare class Hocuspocus {
     documents: Map<string, Document>;
     server?: HocuspocusServer;
     debugger: Debugger;
+    debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => void;
     constructor(configuration?: Partial<Configuration>);
     /**
      * Configure the server
@@ -72,16 +73,11 @@ 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, {
-        timeout: NodeJS.Timeout;
-        start: number;
-    }>;
-    /**
-     * debounce the given function, using the given identifier
-     */
-    debounce(id: string, func: Function, immediately?: boolean): void;
     /**
      * Create a new document by the given request
      */

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

@@ -5,7 +5,8 @@ import { IncomingMessage } from './IncomingMessage.js';
 export declare class MessageReceiver {
     message: IncomingMessage;
     logger: Debugger;
-    constructor(message: IncomingMessage, logger: Debugger);
+    defaultTransactionOrigin?: string;
+    constructor(message: IncomingMessage, logger: Debugger, defaultTransactionOrigin?: string);
     apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
     readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 1 | 2;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;

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

@@ -6,3 +6,4 @@ export * from './IncomingMessage.js';
 export * from './MessageReceiver.js';
 export * from './OutgoingMessage.js';
 export * from './types.js';
+export * from './util/debounce.js';

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
      */
@@ -115,15 +123,6 @@ export interface Configuration extends Extension {
         gc: boolean;
         gcFilter: () => boolean;
     };
-    /**
-     * Function which returns the (customized) document name based on the request
-     */
-    getDocumentName?(data: getDocumentNamePayload): string | Promise<string>;
-}
-export interface getDocumentNamePayload {
-    documentName: string;
-    request: IncomingMessage;
-    requestParameters: URLSearchParams;
 }
 export interface onStatelessPayload {
     connection: Connection;
@@ -190,6 +189,7 @@ export interface onChangePayload {
     requestParameters: URLSearchParams;
     update: Uint8Array;
     socketId: string;
+    transactionOrigin: any;
 }
 export interface beforeHandleMessagePayload {
     clientsCount: number;
@@ -217,6 +217,7 @@ export interface onStoreDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
+    transactionOrigin?: any;
 }
 export interface afterStoreDocumentPayload extends onStoreDocumentPayload {
 }

package/dist/packages/server/src/util/debounce.d.ts

@@ -0,0 +1 @@
+export declare const useDebounce: () => (id: string, func: Function, debounce: number, maxDebounce: number) => void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/extension-database",
   "description": "a generic Hocuspocus persistence driver for the database",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus",
@@ -27,7 +27,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^2.4.0"
+    "@hocuspocus/server": "^2.5.0"
   },
   "peerDependencies": {
     "yjs": "^13.6.4"

package/dist/tests/extension-redis/closeConnections.d.ts

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

package/dist/tests/extension-redis/getConnectionCount.d.ts

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

package/dist/tests/extension-redis/getDocumentsCount.d.ts

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