@hocuspocus/provider 3.2.3 → 3.2.5

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

@@ -1,5 +1,5 @@
 import type { Extension, Hocuspocus, afterLoadDocumentPayload, afterStoreDocumentPayload, beforeBroadcastStatelessPayload, onAwarenessUpdatePayload, onChangePayload, onConfigurePayload, onDisconnectPayload, onStoreDocumentPayload } from "@hocuspocus/server";
-import { Redlock, type ExecutionResult, type Lock } from '@sesamecare-oss/redlock';
+import { type ExecutionResult, type Lock, Redlock } from "@sesamecare-oss/redlock";
 import type { Cluster, ClusterNode, ClusterOptions, RedisOptions } from "ioredis";
 import RedisClient from "ioredis";
 export type RedisInstance = RedisClient | Cluster;
@@ -101,7 +101,7 @@ export declare class Redis implements Extension {
     /**
      * 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.
      */

package/dist/packages/extension-s3/src/S3.d.ts

@@ -0,0 +1,44 @@
+import type { DatabaseConfiguration } from "@hocuspocus/extension-database";
+import { Database } from "@hocuspocus/extension-database";
+import { S3Client } from "@aws-sdk/client-s3";
+export interface S3Configuration extends DatabaseConfiguration {
+    /**
+     * AWS S3 region
+     */
+    region?: string;
+    /**
+     * S3 bucket name
+     */
+    bucket: string;
+    /**
+     * S3 key prefix for documents (optional)
+     */
+    prefix?: string;
+    /**
+     * AWS credentials
+     */
+    credentials?: {
+        accessKeyId: string;
+        secretAccessKey: string;
+    };
+    /**
+     * S3 endpoint URL (for S3-compatible services like MinIO)
+     */
+    endpoint?: string;
+    /**
+     * Force path style URLs (required for MinIO)
+     */
+    forcePathStyle?: boolean;
+    /**
+     * Custom S3 client
+     */
+    s3Client?: S3Client;
+}
+export declare class S3 extends Database {
+    private s3Client?;
+    configuration: S3Configuration;
+    constructor(configuration: Partial<S3Configuration>);
+    private getObjectKey;
+    onConfigure(): Promise<void>;
+    onListen(): Promise<void>;
+}

package/dist/packages/extension-s3/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./S3.ts";

package/dist/packages/extension-webhook/src/index.d.ts

@@ -1,6 +1,6 @@
-import type { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from "@hocuspocus/server";
-import type { Doc } from "yjs";
+import type { Extension, onChangePayload, onConnectPayload, onDisconnectPayload, onLoadDocumentPayload } from "@hocuspocus/server";
 import type { Transformer } from "@hocuspocus/transformer";
+import type { Doc } from "yjs";
 export declare enum Events {
     onChange = "change",
     onConnect = "connect",
@@ -39,7 +39,7 @@ export declare class Webhook implements Extension {
     /**
      * Send a request to the given url containing the given data
      */
-    sendRequest(event: Events, payload: any): Promise<import("axios").AxiosResponse<any, any>>;
+    sendRequest(event: Events, payload: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
     /**
      * onChange hook
      */

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

@@ -4,7 +4,7 @@ import * as Y from "yjs";
 import EventEmitter from "./EventEmitter.ts";
 import type { CompleteHocuspocusProviderWebsocketConfiguration } from "./HocuspocusProviderWebsocket.ts";
 import { HocuspocusProviderWebsocket } from "./HocuspocusProviderWebsocket.ts";
-import type { ConstructableOutgoingMessage, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onSyncedParameters, onUnsyncedChangesParameters } from "./types.ts";
+import type { ConstructableOutgoingMessage, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, onUnsyncedChangesParameters } from "./types.ts";
 export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, "name">> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> | Required<Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">>);
 export interface CompleteHocuspocusProviderConfiguration {
     /**
@@ -40,6 +40,7 @@ export interface CompleteHocuspocusProviderConfiguration {
     onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
     onOpen: (data: onOpenParameters) => void;
     onConnect: () => void;
+    onStatus: (data: onStatusParameters) => void;
     onMessage: (data: onMessageParameters) => void;
     onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
     onSynced: (data: onSyncedParameters) => void;
@@ -69,10 +70,11 @@ export declare class HocuspocusProvider extends EventEmitter {
     boundPageHide: () => void;
     boundOnOpen: (event: Event) => Promise<void>;
     boundOnClose: () => void;
-    forwardConnect: (e: any) => this;
-    forwardClose: (e: any) => this;
-    forwardDisconnect: (e: any) => this;
-    forwardDestroy: (e: any) => this;
+    forwardConnect: () => this;
+    forwardStatus: (e: onStatusParameters) => this;
+    forwardClose: (e: onCloseParameters) => this;
+    forwardDisconnect: (e: onDisconnectParameters) => this;
+    forwardDestroy: () => this;
     setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
     get document(): Y.Doc;
     get isAttached(): boolean;

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

@@ -2,6 +2,7 @@ import type WebSocket from "ws";
 import { Awareness } from "y-protocols/awareness";
 import { Doc } from "yjs";
 import type Connection from "./Connection.ts";
+import { Mutex } from "async-mutex";
 export declare class Document extends Doc {
     awareness: Awareness;
     callbacks: {
@@ -16,6 +17,7 @@ export declare class Document extends Doc {
     name: string;
     isLoading: boolean;
     isDestroyed: boolean;
+    saveMutex: Mutex;
     /**
      * Constructor.
      */

package/dist/playground/backend/src/s3-redis.d.ts

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

package/dist/playground/backend/src/s3.d.ts

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

package/dist/tests/extension-s3/fetch.d.ts

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

package/package.json

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

package/src/HocuspocusProvider.ts

@@ -25,6 +25,7 @@ import type {
 	onOpenParameters,
 	onOutgoingMessageParameters,
 	onStatelessParameters,
+	onStatusParameters,
 	onSyncedParameters,
 	onUnsyncedChangesParameters,
 } from "./types.ts";
@@ -79,6 +80,7 @@ export interface CompleteHocuspocusProviderConfiguration {
 	onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
 	onOpen: (data: onOpenParameters) => void;
 	onConnect: () => void;
+	onStatus: (data: onStatusParameters) => void;
 	onMessage: (data: onMessageParameters) => void;
 	onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
 	onSynced: (data: onSyncedParameters) => void;
@@ -111,6 +113,7 @@ export class HocuspocusProvider extends EventEmitter {
 		onMessage: () => null,
 		onOutgoingMessage: () => null,
 		onSynced: () => null,
+		onStatus: () => null,
 		onDisconnect: () => null,
 		onClose: () => null,
 		onDestroy: () => null,
@@ -204,13 +207,15 @@ export class HocuspocusProvider extends EventEmitter {
 
 	boundOnClose = this.onClose.bind(this);
 
-	forwardConnect = (e: any) => this.emit("connect", e);
+	forwardConnect = () => this.emit("connect");
 
-	forwardClose = (e: any) => this.emit("close", e);
+	forwardStatus = (e: onStatusParameters) => this.emit("status", e);
 
-	forwardDisconnect = (e: any) => this.emit("disconnect", e);
+	forwardClose = (e: onCloseParameters) => this.emit("close", e);
 
-	forwardDestroy = (e: any) => this.emit("destroy", e);
+	forwardDisconnect = (e: onDisconnectParameters) => this.emit("disconnect", e);
+
+	forwardDestroy = () => this.emit("destroy");
 
 	public setConfiguration(
 		configuration: Partial<HocuspocusProviderConfiguration> = {},
@@ -489,6 +494,13 @@ export class HocuspocusProvider extends EventEmitter {
 			this.configuration.onConnect,
 		);
 		this.configuration.websocketProvider.off("connect", this.forwardConnect);
+
+		this.configuration.websocketProvider.off("status", this.forwardStatus);
+		this.configuration.websocketProvider.off(
+			"status",
+			this.configuration.onStatus,
+		);
+
 		this.configuration.websocketProvider.off("open", this.boundOnOpen);
 		this.configuration.websocketProvider.off("close", this.boundOnClose);
 		this.configuration.websocketProvider.off(
@@ -524,6 +536,12 @@ export class HocuspocusProvider extends EventEmitter {
 		);
 		this.configuration.websocketProvider.on("connect", this.forwardConnect);
 
+		this.configuration.websocketProvider.on(
+			"status",
+			this.configuration.onStatus,
+		);
+		this.configuration.websocketProvider.on("status", this.forwardStatus);
+
 		this.configuration.websocketProvider.on("open", this.boundOnOpen);
 
 		this.configuration.websocketProvider.on("close", this.boundOnClose);

package/src/HocuspocusProviderWebsocket.ts

@@ -195,6 +195,8 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 
 	async onOpen(event: Event) {
 		this.status = WebSocketStatus.Connected;
+		this.emit("status", { status: WebSocketStatus.Connected });
+
 		this.cancelWebsocketRetry = undefined;
 		this.receivedOnOpenPayload = event;
 	}