@hocuspocus/provider 3.2.5 → 3.3.0

package/dist/packages/common/src/auth.d.ts

@@ -1,6 +1,12 @@
 import * as encoding from "lib0/encoding";
 import * as decoding from "lib0/decoding";
+export declare enum AuthMessageType {
+    Token = 0,
+    PermissionDenied = 1,
+    Authenticated = 2
+}
 export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
 export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
 export declare const writeAuthenticated: (encoder: encoding.Encoder, scope: "readonly" | "read-write") => void;
-export declare const readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;
+export declare const writeTokenSyncRequest: (encoder: encoding.Encoder) => void;
+export declare const readAuthMessage: (decoder: decoding.Decoder, sendToken: () => void, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;

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

@@ -1,4 +1,4 @@
-import type { Extension, Hocuspocus, afterLoadDocumentPayload, afterStoreDocumentPayload, beforeBroadcastStatelessPayload, onAwarenessUpdatePayload, onChangePayload, onConfigurePayload, onDisconnectPayload, onStoreDocumentPayload } from "@hocuspocus/server";
+import type { Extension, Hocuspocus, afterLoadDocumentPayload, afterStoreDocumentPayload, afterUnloadDocumentPayload, beforeBroadcastStatelessPayload, beforeUnloadDocumentPayload, onAwarenessUpdatePayload, onChangePayload, onConfigurePayload, onStoreDocumentPayload } from "@hocuspocus/server";
 import { type ExecutionResult, type Lock, Redlock } from "@sesamecare-oss/redlock";
 import type { Cluster, ClusterNode, ClusterOptions, RedisOptions } from "ioredis";
 import RedisClient from "ioredis";
@@ -67,11 +67,6 @@ export declare class Redis implements Extension {
         release?: Promise<ExecutionResult>;
     }>;
     messagePrefix: Buffer;
-    /**
-     * When we have a high frequency of updates to a document we don't need tons of setTimeouts
-     * piling up, so we'll track them to keep it to the most recent per document.
-     */
-    private pendingDisconnects;
     private pendingAfterStoreDocumentResolves;
     constructor(configuration: Partial<Configuration>);
     onConfigure({ instance }: onConfigurePayload): Promise<void>;
@@ -117,10 +112,10 @@ export declare class Redis implements Extension {
      */
     onChange(data: onChangePayload): Promise<any>;
     /**
-     * Make sure to *not* listen for further changes, when there’s
-     * no one connected anymore.
+     * Delay unloading to allow syncs to finish
      */
-    onDisconnect: ({ documentName }: onDisconnectPayload) => Promise<void>;
+    beforeUnloadDocument(data: beforeUnloadDocumentPayload): Promise<void>;
+    afterUnloadDocument(data: afterUnloadDocumentPayload): Promise<void>;
     beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
     /**
      * Kill the Redlock connection immediately.

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

@@ -87,6 +87,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     pageHide(): void;
     registerEventListeners(): void;
     sendStateless(payload: string): void;
+    sendToken(): Promise<void>;
     documentUpdateHandler(update: Uint8Array, origin: any): void;
     awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
     /**

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

@@ -2,7 +2,7 @@ import type { IncomingMessage as HTTPIncomingMessage } from "node:http";
 import { type CloseEvent } from "@hocuspocus/common";
 import type WebSocket from "ws";
 import type Document from "./Document.ts";
-import type { beforeSyncPayload, onStatelessPayload } from "./types.ts";
+import type { beforeSyncPayload, onTokenSyncPayload, onStatelessPayload } from "./types.ts";
 export declare class Connection {
     webSocket: WebSocket;
     context: any;
@@ -13,6 +13,7 @@ export declare class Connection {
         beforeHandleMessage: (connection: Connection, update: Uint8Array) => Promise<void>;
         beforeSync: (connection: Connection, payload: Pick<beforeSyncPayload, "type" | "payload">) => Promise<void>;
         statelessCallback: (payload: onStatelessPayload) => Promise<void>;
+        onTokenSyncCallback: (payload: Partial<onTokenSyncPayload>) => Promise<void>;
     };
     socketId: string;
     readOnly: boolean;
@@ -36,6 +37,10 @@ export declare class Connection {
      * Set a callback that will be triggered before a sync message is handled
      */
     beforeSync(callback: (connection: Connection, payload: Pick<beforeSyncPayload, "type" | "payload">) => Promise<any>): Connection;
+    /**
+       * Set a callback that will be triggered when on token sync message is received
+       */
+    onTokenSyncCallback(callback: (payload: onTokenSyncPayload) => Promise<void>): Connection;
     /**
      * Send the given message
      */
@@ -44,6 +49,10 @@ export declare class Connection {
      * Send a stateless message with payload
      */
     sendStateless(payload: string): void;
+    /**
+     * Request current token from the client
+     */
+    requestToken(): void;
     /**
      * Graceful wrapper around the WebSocket close method.
      */

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

@@ -19,6 +19,7 @@ export declare const defaultConfiguration: {
 export declare class Hocuspocus {
     configuration: Configuration;
     loadingDocuments: Map<string, Promise<Document>>;
+    unloadingDocuments: Map<string, Promise<void>>;
     documents: Map<string, Document>;
     server?: Server;
     debouncer: {

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

@@ -10,6 +10,7 @@ export declare class OutgoingMessage {
     createSyncReplyMessage(): OutgoingMessage;
     createAwarenessUpdateMessage(awareness: Awareness, changedClients?: Array<any>): OutgoingMessage;
     writeQueryAwareness(): OutgoingMessage;
+    writeTokenSyncRequest(): OutgoingMessage;
     writeAuthenticated(readonly: boolean): OutgoingMessage;
     writePermissionDenied(reason: string): OutgoingMessage;
     writeFirstSyncStepFor(document: Document): OutgoingMessage;

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

@@ -34,6 +34,7 @@ export interface Extension {
     onConnect?(data: onConnectPayload): Promise<any>;
     connected?(data: connectedPayload): Promise<any>;
     onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
+    onTokenSync?(data: onTokenSyncPayload): Promise<any>;
     onCreateDocument?(data: onCreateDocumentPayload): Promise<any>;
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     afterLoadDocument?(data: afterLoadDocumentPayload): Promise<any>;
@@ -51,7 +52,7 @@ export interface Extension {
     afterUnloadDocument?(data: afterUnloadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export type HookName = "onConfigure" | "onListen" | "onUpgrade" | "onConnect" | "connected" | "onAuthenticate" | "onCreateDocument" | "onLoadDocument" | "afterLoadDocument" | "beforeHandleMessage" | "beforeBroadcastStateless" | "beforeSync" | "onStateless" | "onChange" | "onStoreDocument" | "afterStoreDocument" | "onAwarenessUpdate" | "onRequest" | "onDisconnect" | "beforeUnloadDocument" | "afterUnloadDocument" | "onDestroy";
+export type HookName = "onConfigure" | "onListen" | "onUpgrade" | "onConnect" | "connected" | "onAuthenticate" | "onTokenSync" | "onCreateDocument" | "onLoadDocument" | "afterLoadDocument" | "beforeHandleMessage" | "beforeBroadcastStateless" | "beforeSync" | "onStateless" | "onChange" | "onStoreDocument" | "afterStoreDocument" | "onAwarenessUpdate" | "onRequest" | "onDisconnect" | "beforeUnloadDocument" | "afterUnloadDocument" | "onDestroy";
 export type HookPayloadByName = {
     onConfigure: onConfigurePayload;
     onListen: onListenPayload;
@@ -59,6 +60,7 @@ export type HookPayloadByName = {
     onConnect: onConnectPayload;
     connected: connectedPayload;
     onAuthenticate: onAuthenticatePayload;
+    onTokenSync: onTokenSyncPayload;
     onCreateDocument: onCreateDocumentPayload;
     onLoadDocument: onLoadDocumentPayload;
     afterLoadDocument: afterLoadDocumentPayload;
@@ -135,6 +137,18 @@ export interface onAuthenticatePayload {
     token: string;
     connectionConfig: ConnectionConfiguration;
 }
+export interface onTokenSyncPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    token: string;
+    connectionConfig: ConnectionConfiguration;
+    connection: Connection;
+}
 export interface onCreateDocumentPayload {
     context: any;
     documentName: string;

package/dist/tests/server/onTokenSync.d.ts

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

package/package.json

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

package/src/HocuspocusProvider.ts

@@ -304,6 +304,21 @@ export class HocuspocusProvider extends EventEmitter {
 		});
 	}
 
+	async sendToken() {
+		let token: string | null;
+		try {
+			token = await this.getToken();
+		} catch (error) {
+			this.permissionDeniedHandler(`Failed to get token during sendToken(): ${error}`);
+			return;
+		}
+
+		this.send(AuthenticationMessage, {
+			token: token ?? "",
+			documentName: this.configuration.name,
+		});
+	}
+
 	documentUpdateHandler(update: Uint8Array, origin: any) {
 		if (origin === this) {
 			return;
@@ -374,20 +389,7 @@ export class HocuspocusProvider extends EventEmitter {
 		this.isAuthenticated = false;
 
 		this.emit("open", { event });
-
-		let token: string | null;
-		try {
-			token = await this.getToken();
-		} catch (error) {
-			this.permissionDeniedHandler(`Failed to get token: ${error}`);
-			return;
-		}
-
-		this.send(AuthenticationMessage, {
-			token: token ?? "",
-			documentName: this.configuration.name,
-		});
-
+		await this.sendToken();
 		this.startSync();
 	}
 

package/src/MessageReceiver.ts

@@ -117,6 +117,7 @@ export class MessageReceiver {
 
 		readAuthMessage(
 			message.decoder,
+			provider.sendToken.bind(provider),
 			provider.permissionDeniedHandler.bind(provider),
 			provider.authenticatedHandler.bind(provider),
 		);