@hocuspocus/provider 3.2.1 → 3.2.3

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

@@ -1,7 +1,8 @@
 import type { Extension, Hocuspocus, afterLoadDocumentPayload, afterStoreDocumentPayload, beforeBroadcastStatelessPayload, onAwarenessUpdatePayload, onChangePayload, onConfigurePayload, onDisconnectPayload, onStoreDocumentPayload } from "@hocuspocus/server";
-import type { ClusterNode, ClusterOptions, RedisOptions } from "ioredis";
-import Redlock from "redlock";
-export type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
+import { Redlock, type ExecutionResult, type Lock } from '@sesamecare-oss/redlock';
+import type { Cluster, ClusterNode, ClusterOptions, RedisOptions } from "ioredis";
+import RedisClient from "ioredis";
+export type RedisInstance = RedisClient | Cluster;
 export interface Configuration {
     /**
      * Redis port
@@ -61,7 +62,10 @@ export declare class Redis implements Extension {
     sub: RedisInstance;
     instance: Hocuspocus;
     redlock: Redlock;
-    locks: Map<string, Redlock.Lock>;
+    locks: Map<string, {
+        lock: Lock;
+        release?: Promise<ExecutionResult>;
+    }>;
     messagePrefix: Buffer;
     /**
      * When we have a high frequency of updates to a document we don't need tons of setTimeouts
@@ -93,15 +97,15 @@ export declare class Redis implements Extension {
      * Before the document is stored, make sure to set a lock in Redis.
      * That’s meant to avoid conflicts with other instances trying to store the document.
      */
-    onStoreDocument({ documentName }: onStoreDocumentPayload): Promise<unknown>;
+    onStoreDocument({ documentName }: onStoreDocumentPayload): Promise<void>;
     /**
      * Release the Redis lock, so other instances can store documents.
      */
-    afterStoreDocument({ documentName, socketId, }: afterStoreDocumentPayload): Promise<void>;
+    afterStoreDocument({ documentName, socketId }: afterStoreDocumentPayload): Promise<void>;
     /**
      * Handle awareness update messages received directly by this Hocuspocus instance.
      */
-    onAwarenessUpdate({ documentName, awareness, added, updated, removed, }: onAwarenessUpdatePayload): Promise<any>;
+    onAwarenessUpdate({ documentName, awareness, added, updated, removed, }: onAwarenessUpdatePayload): Promise<number>;
     /**
      * Handle incoming messages published on subscribed document channels.
      * Note that this will also include messages from ourselves as it is not possible
@@ -117,7 +121,7 @@ export declare class Redis implements Extension {
      * no one connected anymore.
      */
     onDisconnect: ({ documentName }: onDisconnectPayload) => Promise<void>;
-    beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<any>;
+    beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
     /**
      * Kill the Redlock connection immediately.
      */

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

@@ -2,11 +2,16 @@ import type { Event, MessageEvent } from "ws";
 import EventEmitter from "./EventEmitter.ts";
 import type { HocuspocusProvider } from "./HocuspocusProvider.ts";
 import { WebSocketStatus, type onAwarenessChangeParameters, type onAwarenessUpdateParameters, type onCloseParameters, type onDisconnectParameters, type onMessageParameters, type onOpenParameters, type onOutgoingMessageParameters, type onStatusParameters } from "./types.ts";
-export type HocusPocusWebSocket = WebSocket & {
+export type HocuspocusWebSocket = WebSocket & {
     identifier: string;
 };
+export type HocusPocusWebSocket = HocuspocusWebSocket;
 export type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
 export interface CompleteHocuspocusProviderWebsocketConfiguration {
+    /**
+     * Whether to connect automatically when creating the provider instance. Default=true
+     */
+    autoConnect: boolean;
     /**
      * URL of your @hocuspocus/server instance
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hocuspocus/provider",
-	"version": "3.2.1",
+	"version": "3.2.3",
 	"description": "hocuspocus provider",
 	"homepage": "https://hocuspocus.dev",
 	"keywords": [
@@ -29,7 +29,7 @@
 		"dist"
 	],
 	"dependencies": {
-		"@hocuspocus/common": "^3.2.1",
+		"@hocuspocus/common": "^3.2.3",
 		"@lifeomic/attempt": "^3.0.2",
 		"lib0": "^0.2.87",
 		"ws": "^8.17.1"

package/src/HocuspocusProviderWebsocket.ts

@@ -18,7 +18,8 @@ import {
 	type onStatusParameters,
 } from "./types.ts";
 
-export type HocusPocusWebSocket = WebSocket & { identifier: string };
+export type HocuspocusWebSocket = WebSocket & { identifier: string };
+export type HocusPocusWebSocket = HocuspocusWebSocket;
 
 export type HocuspocusProviderWebsocketConfiguration = Required<
 	Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">
@@ -26,6 +27,11 @@ export type HocuspocusProviderWebsocketConfiguration = Required<
 	Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
 
 export interface CompleteHocuspocusProviderWebsocketConfiguration {
+	/**
+	 * Whether to connect automatically when creating the provider instance. Default=true
+	 */
+	autoConnect: boolean;
+
 	/**
 	 * URL of your @hocuspocus/server instance
 	 */
@@ -95,6 +101,7 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 
 	public configuration: CompleteHocuspocusProviderWebsocketConfiguration = {
 		url: "",
+		autoConnect: true,
 		// @ts-ignore
 		document: undefined,
 		WebSocketPolyfill: undefined,
@@ -179,11 +186,9 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 			this.configuration.messageReconnectTimeout / 10,
 		);
 
-		if (!this.shouldConnect) {
-			return;
+		if (this.shouldConnect) {
+			this.connect();
 		}
-
-		this.connect();
 	}
 
 	receivedOnOpenPayload?: Event | undefined = undefined;
@@ -222,6 +227,10 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 		configuration: Partial<HocuspocusProviderWebsocketConfiguration> = {},
 	): void {
 		this.configuration = { ...this.configuration, ...configuration };
+
+		if (!this.configuration.autoConnect) {
+			this.shouldConnect = false;
+		}
 	}
 
 	cancelWebsocketRetry?: () => void;