@hocuspocus/provider 3.4.3 → 3.4.4

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

@@ -1,5 +1,6 @@
 import * as encoding from "lib0/encoding";
 import * as decoding from "lib0/decoding";
+import type { AuthorizedScope } from "../../provider/src";
 export declare enum AuthMessageType {
     Token = 0,
     PermissionDenied = 1,
@@ -7,6 +8,6 @@ export declare enum AuthMessageType {
 }
 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 writeAuthenticated: (encoder: encoding.Encoder, scope: AuthorizedScope) => 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/provider/src/HocuspocusProvider.d.ts

@@ -4,8 +4,8 @@ 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, onStatusParameters, onSyncedParameters, onUnsyncedChangesParameters } from "./types.ts";
-export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, "name">> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> | Required<Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">>);
+import type { AuthorizedScope, 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">> & Partial<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "preserveTrailingSlash">>) | Required<Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">>);
 export interface CompleteHocuspocusProviderConfiguration {
     /**
      * The identifier/name of your document
@@ -60,7 +60,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     isSynced: boolean;
     unsyncedChanges: number;
     isAuthenticated: boolean;
-    authorizedScope: string | undefined;
+    authorizedScope: AuthorizedScope | undefined;
     manageSocket: boolean;
     private _isAttached;
     intervals: any;

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

@@ -16,6 +16,11 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
      * URL of your @hocuspocus/server instance
      */
     url: string;
+    /**
+     * By default, trailing slashes are removed from the URL. Set this to true
+     * to preserve trailing slashes if your server configuration requires them.
+     */
+    preserveTrailingSlash: boolean;
     /**
      * An optional WebSocket polyfill, for example for Node.js
      */

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

@@ -25,6 +25,7 @@ export declare enum WebSocketStatus {
     Connected = "connected",
     Disconnected = "disconnected"
 }
+export type AuthorizedScope = "read-write" | "readonly";
 export interface OutgoingMessageInterface {
     encoder: Encoder;
     type?: MessageType;
@@ -50,7 +51,7 @@ export type onAuthenticationFailedParameters = {
     reason: string;
 };
 export type onAuthenticatedParameters = {
-    scope: "read-write" | "readonly";
+    scope: AuthorizedScope;
 };
 export type onOpenParameters = {
     event: Event;

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, onTokenSyncPayload } from "./types.ts";
+import type { beforeSyncPayload, onStatelessPayload } from "./types.ts";
 export declare class Connection {
     webSocket: WebSocket;
     context: any;
@@ -13,7 +13,9 @@ 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>;
+        onTokenSyncCallback: (payload: {
+            token: string;
+        }) => Promise<void>;
     };
     socketId: string;
     readOnly: boolean;
@@ -40,7 +42,9 @@ export declare class Connection {
     /**
      * Set a callback that will be triggered when on token sync message is received
      */
-    onTokenSyncCallback(callback: (payload: onTokenSyncPayload) => Promise<void>): Connection;
+    onTokenSyncCallback(callback: (payload: {
+        token: string;
+    }) => Promise<void>): Connection;
     /**
      * Send the given message
      */

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

@@ -6,6 +6,6 @@ export declare class MessageReceiver {
     defaultTransactionOrigin?: string;
     constructor(message: IncomingMessage, 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;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

package/package.json

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

package/src/HocuspocusProvider.ts

@@ -14,6 +14,7 @@ import { StatelessMessage } from "./OutgoingMessages/StatelessMessage.ts";
 import { SyncStepOneMessage } from "./OutgoingMessages/SyncStepOneMessage.ts";
 import { UpdateMessage } from "./OutgoingMessages/UpdateMessage.ts";
 import type {
+	AuthorizedScope,
 	ConstructableOutgoingMessage,
 	onAuthenticatedParameters,
 	onAuthenticationFailedParameters,
@@ -35,7 +36,13 @@ export type HocuspocusProviderConfiguration = Required<
 > &
 	Partial<CompleteHocuspocusProviderConfiguration> &
 	(
-		| Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">>
+		| (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, "url">> &
+				Partial<
+					Pick<
+						CompleteHocuspocusProviderWebsocketConfiguration,
+						"preserveTrailingSlash"
+					>
+				>)
 		| Required<
 				Pick<CompleteHocuspocusProviderConfiguration, "websocketProvider">
 		  >
@@ -129,7 +136,7 @@ export class HocuspocusProvider extends EventEmitter {
 
 	isAuthenticated = false;
 
-	authorizedScope: string | undefined = undefined;
+	authorizedScope: AuthorizedScope | undefined = undefined;
 
 	// @internal
 	manageSocket = false;
@@ -221,12 +228,10 @@ export class HocuspocusProvider extends EventEmitter {
 		configuration: Partial<HocuspocusProviderConfiguration> = {},
 	): void {
 		if (!configuration.websocketProvider) {
-			const websocketProviderConfig =
-				configuration as CompleteHocuspocusProviderWebsocketConfiguration;
 			this.manageSocket = true;
-			this.configuration.websocketProvider = new HocuspocusProviderWebsocket({
-				url: websocketProviderConfig.url,
-			});
+			this.configuration.websocketProvider = new HocuspocusProviderWebsocket(
+				configuration as CompleteHocuspocusProviderWebsocketConfiguration,
+			);
 		}
 
 		this.configuration = { ...this.configuration, ...configuration };
@@ -309,7 +314,9 @@ export class HocuspocusProvider extends EventEmitter {
 		try {
 			token = await this.getToken();
 		} catch (error) {
-			this.permissionDeniedHandler(`Failed to get token during sendToken(): ${error}`);
+			this.permissionDeniedHandler(
+				`Failed to get token during sendToken(): ${error}`,
+			);
 			return;
 		}
 
@@ -580,7 +587,7 @@ export class HocuspocusProvider extends EventEmitter {
 
 	authenticatedHandler(scope: string) {
 		this.isAuthenticated = true;
-		this.authorizedScope = scope;
+		this.authorizedScope = scope as AuthorizedScope;
 
 		this.emit("authenticated", { scope });
 	}

package/src/HocuspocusProviderWebsocket.ts

@@ -37,6 +37,12 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
 	 */
 	url: string;
 
+	/**
+	 * By default, trailing slashes are removed from the URL. Set this to true
+	 * to preserve trailing slashes if your server configuration requires them.
+	 */
+	preserveTrailingSlash: boolean;
+
 	/**
 	 * An optional WebSocket polyfill, for example for Node.js
 	 */
@@ -102,6 +108,7 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 	public configuration: CompleteHocuspocusProviderWebsocketConfiguration = {
 		url: "",
 		autoConnect: true,
+		preserveTrailingSlash: false,
 		// @ts-ignore
 		document: undefined,
 		WebSocketPolyfill: undefined,
@@ -434,13 +441,18 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 		}
 	}
 
-	// Ensure that the URL never ends with /
 	get serverUrl() {
-		while (this.configuration.url[this.configuration.url.length - 1] === "/") {
-			return this.configuration.url.slice(0, this.configuration.url.length - 1);
+		if (this.configuration.preserveTrailingSlash) {
+			return this.configuration.url;
+		}
+
+		// By default, ensure that the URL never ends with /
+		let url = this.configuration.url;
+		while (url[url.length - 1] === "/") {
+			url = url.slice(0, url.length - 1);
 		}
 
-		return this.configuration.url;
+		return url;
 	}
 
 	get url() {

package/src/MessageReceiver.ts

@@ -1,8 +1,8 @@
 import { readAuthMessage } from "@hocuspocus/common";
 import { readVarInt, readVarString } from "lib0/decoding";
+import type { CloseEvent } from "ws";
 import * as awarenessProtocol from "y-protocols/awareness";
 import { messageYjsSyncStep2, readSyncMessage } from "y-protocols/sync";
-import type { CloseEvent } from "ws";
 import type { HocuspocusProvider } from "./HocuspocusProvider.ts";
 import type { IncomingMessage } from "./IncomingMessage.ts";
 import { OutgoingMessage } from "./OutgoingMessage.ts";
@@ -60,7 +60,7 @@ export class MessageReceiver {
 				};
 				provider.onClose();
 				provider.configuration.onClose({ event });
-				provider.forwardClose(event);
+				provider.forwardClose({ event });
 				break;
 
 			default:

package/src/types.ts

@@ -28,6 +28,8 @@ export enum WebSocketStatus {
 	Disconnected = "disconnected",
 }
 
+export type AuthorizedScope = "read-write" | "readonly";
+
 export interface OutgoingMessageInterface {
 	encoder: Encoder;
 	type?: MessageType;
@@ -62,7 +64,7 @@ export type onAuthenticationFailedParameters = {
 };
 
 export type onAuthenticatedParameters = {
-	scope: "read-write" | "readonly";
+	scope: AuthorizedScope;
 };
 
 export type onOpenParameters = {