@hocuspocus/extension-redis 2.3.1 → 2.4.0-rc.0

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

@@ -21,8 +21,13 @@ export interface CompleteHocuspocusProviderConfiguration {
     broadcast: boolean;
     /**
      * An Awareness instance to keep the presence state of all clients.
+     *
+     * You can disable sharing awareness information by passing `null`.
+     * Note that having no awareness information shared across all connections will break our ping checks
+     * and thus trigger reconnects. You should always have at least one Provider with enabled awareness per
+     * socket connection, or ensure that the Provider receives messages before running into `HocuspocusProviderWebsocket.messageReconnectTimeout`.
      */
-    awareness: Awareness;
+    awareness: Awareness | null;
     /**
      * A token that’s sent to the backend for authentication purposes.
      */
@@ -68,6 +73,9 @@ export interface CompleteHocuspocusProviderConfiguration {
      */
     preserveConnection: boolean;
 }
+export declare class AwarenessError extends Error {
+    code: number;
+}
 export declare class HocuspocusProvider extends EventEmitter {
     configuration: CompleteHocuspocusProviderConfiguration;
     subscribedToBroadcastChannel: boolean;
@@ -94,7 +102,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     onStatus({ status }: onStatusParameters): void;
     setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
     get document(): Y.Doc;
-    get awareness(): Awareness;
+    get awareness(): Awareness | null;
     get hasUnsyncedChanges(): boolean;
     incrementUnsyncedChanges(): void;
     decrementUnsyncedChanges(): void;

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

@@ -24,7 +24,7 @@ export declare class Document extends Doc {
      */
     constructor(name: string, logger: Debugger, yDocOptions: {});
     /**
-     * Check if the Document is empty
+     * Check if the Document (XMLFragment or Map) is empty
      */
     isEmpty(fieldName: string): boolean;
     /**

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

@@ -7,10 +7,13 @@ export declare class IncomingMessage {
      */
     decoder: Decoder;
     /**
-     * Access to the reply.
+     * Private encoder; can be undefined.
+     *
+     * Lazy creation of the encoder speeds up IncomingMessages that need only a decoder.
      */
-    encoder: Encoder;
+    private encoderInternal?;
     constructor(input: any);
+    get encoder(): Encoder;
     readVarUint8Array(): Uint8Array;
     readVarUint(): number;
     readVarString(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-redis",
-  "version": "2.3.1",
+  "version": "2.4.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.3.1",
+    "@hocuspocus/server": "^2.4.0-rc.0",
     "ioredis": "^4.28.2",
     "kleur": "^4.1.4",
     "lodash.debounce": "^4.0.8",