@hocuspocus/provider 3.4.6-rc.2 → 4.0.0-rc.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023, Tiptap GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/hocuspocus-provider.cjs

@@ -31,7 +31,7 @@ let yjs = require("yjs");
 yjs = __toESM(yjs);
 let _lifeomic_attempt = require("@lifeomic/attempt");
 
-//#region node_modules/lib0/math.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/math.js
 /**
 * Common Math expressions.
 *
@@ -55,7 +55,7 @@ const max = (a, b) => a > b ? a : b;
 const isNaN$1 = Number.isNaN;
 
 //#endregion
-//#region node_modules/lib0/binary.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/binary.js
 const BIT7 = 64;
 const BIT8 = 128;
 const BIT18 = 1 << 17;
@@ -99,7 +99,7 @@ const BITS31 = 2147483647;
 const BITS32 = 4294967295;
 
 //#endregion
-//#region node_modules/lib0/number.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/number.js
 /**
 * Utility helpers for working with numbers.
 *
@@ -116,7 +116,7 @@ const isNaN = Number.isNaN;
 const parseInt = Number.parseInt;
 
 //#endregion
-//#region node_modules/lib0/set.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/set.js
 /**
 * Utility module to work with sets.
 *
@@ -125,7 +125,7 @@ const parseInt = Number.parseInt;
 const create$2 = () => /* @__PURE__ */ new Set();
 
 //#endregion
-//#region node_modules/lib0/array.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/array.js
 /**
 * Transforms something array-like to an actual Array.
 *
@@ -138,7 +138,7 @@ const from = Array.from;
 const isArray$1 = Array.isArray;
 
 //#endregion
-//#region node_modules/lib0/string.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/string.js
 /**
 * Utility module to work with strings.
 *
@@ -153,7 +153,7 @@ const fromCodePoint = String.fromCodePoint;
 const MAX_UTF16_CHARACTER = fromCharCode(65535);
 /**
 * @param {string} str
-* @return {Uint8Array}
+* @return {Uint8Array<ArrayBuffer>}
 */
 const _encodeUtf8Polyfill = (str) => {
 	const encodedString = unescape(encodeURIComponent(str));
@@ -166,7 +166,7 @@ const _encodeUtf8Polyfill = (str) => {
 const utf8TextEncoder = typeof TextEncoder !== "undefined" ? new TextEncoder() : null;
 /**
 * @param {string} str
-* @return {Uint8Array}
+* @return {Uint8Array<ArrayBuffer>}
 */
 const _encodeUtf8Native = (str) => utf8TextEncoder.encode(str);
 /**
@@ -186,7 +186,7 @@ if (utf8TextDecoder && utf8TextDecoder.decode(new Uint8Array()).length === 1)
 utf8TextDecoder = null;
 
 //#endregion
-//#region node_modules/lib0/encoding.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/encoding.js
 /**
 * Efficient schema-less binary encoding with support for variable length encoding.
 *
@@ -239,7 +239,7 @@ const createEncoder = () => new Encoder();
 * @param {Encoder} encoder
 * @return {number}
 */
-const length$1 = (encoder) => {
+const length = (encoder) => {
 	let len = encoder.cpos;
 	for (let i = 0; i < encoder.bufs.length; i++) len += encoder.bufs[i].length;
 	return len;
@@ -249,10 +249,10 @@ const length$1 = (encoder) => {
 *
 * @function
 * @param {Encoder} encoder
-* @return {Uint8Array} The created ArrayBuffer.
+* @return {Uint8Array<ArrayBuffer>} The created ArrayBuffer.
 */
 const toUint8Array = (encoder) => {
-	const uint8arr = new Uint8Array(length$1(encoder));
+	const uint8arr = new Uint8Array(length(encoder));
 	let curPos = 0;
 	for (let i = 0; i < encoder.bufs.length; i++) {
 		const d = encoder.bufs[i];
@@ -368,7 +368,7 @@ const writeVarUint8Array = (encoder, uint8Array) => {
 };
 
 //#endregion
-//#region node_modules/lib0/error.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/error.js
 /**
 * Error helpers.
 *
@@ -382,7 +382,7 @@ const writeVarUint8Array = (encoder, uint8Array) => {
 const create$1 = (s) => new Error(s);
 
 //#endregion
-//#region node_modules/lib0/decoding.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/decoding.js
 /**
 * Efficient schema-less binary decoding with support for variable length encoding.
 *
@@ -414,16 +414,17 @@ const errorUnexpectedEndOfArray = create$1("Unexpected end of array");
 const errorIntegerOutOfRange = create$1("Integer out of Range");
 /**
 * A Decoder handles the decoding of an Uint8Array.
+* @template {ArrayBufferLike} [Buf=ArrayBufferLike]
 */
 var Decoder = class {
 	/**
-	* @param {Uint8Array} uint8Array Binary data to decode
+	* @param {Uint8Array<Buf>} uint8Array Binary data to decode
 	*/
 	constructor(uint8Array) {
 		/**
 		* Decoding target.
 		*
-		* @type {Uint8Array}
+		* @type {Uint8Array<Buf>}
 		*/
 		this.arr = uint8Array;
 		/**
@@ -436,8 +437,9 @@ var Decoder = class {
 };
 /**
 * @function
-* @param {Uint8Array} uint8Array
-* @return {Decoder}
+* @template {ArrayBufferLike} Buf
+* @param {Uint8Array<Buf>} uint8Array
+* @return {Decoder<Buf>}
 */
 const createDecoder = (uint8Array) => new Decoder(uint8Array);
 /**
@@ -447,9 +449,10 @@ const createDecoder = (uint8Array) => new Decoder(uint8Array);
 *            Use `buffer.copyUint8Array` to copy the result into a new Uint8Array.
 *
 * @function
-* @param {Decoder} decoder The decoder instance
+* @template {ArrayBufferLike} Buf
+* @param {Decoder<Buf>} decoder The decoder instance
 * @param {number} len The length of bytes to read
-* @return {Uint8Array}
+* @return {Uint8Array<Buf>}
 */
 const readUint8Array = (decoder, len) => {
 	const view = new Uint8Array(decoder.arr.buffer, decoder.pos + decoder.arr.byteOffset, len);
@@ -463,8 +466,9 @@ const readUint8Array = (decoder, len) => {
 *            Use `buffer.copyUint8Array` to copy the result into a new Uint8Array.
 *
 * @function
-* @param {Decoder} decoder
-* @return {Uint8Array}
+* @template {ArrayBufferLike} Buf
+* @param {Decoder<Buf>} decoder
+* @return {Uint8Array<Buf>}
 */
 const readVarUint8Array = (decoder) => readUint8Array(decoder, readVarUint(decoder));
 /**
@@ -589,7 +593,7 @@ const peekVarString = (decoder) => {
 };
 
 //#endregion
-//#region node_modules/lib0/time.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/time.js
 /**
 * Return current unix time.
 *
@@ -598,13 +602,18 @@ const peekVarString = (decoder) => {
 const getUnixTime = Date.now;
 
 //#endregion
-//#region node_modules/lib0/map.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/map.js
 /**
 * Utility module to work with key-value stores.
 *
 * @module map
 */
 /**
+* @template K
+* @template V
+* @typedef {Map<K,V>} GlobalMap
+*/
+/**
 * Creates a new Map instance.
 *
 * @function
@@ -636,7 +645,7 @@ const setIfUndefined = (map, key, createT) => {
 };
 
 //#endregion
-//#region node_modules/lib0/observable.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/observable.js
 /**
 * Observable class prototype.
 *
@@ -708,41 +717,36 @@ var Observable = class {
 /* c8 ignore end */
 
 //#endregion
-//#region node_modules/lib0/object.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/trait/equality.js
+const EqualityTraitSymbol = Symbol("Equality");
+
+//#endregion
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/object.js
 /**
 * @param {Object<string,any>} obj
 */
 const keys = Object.keys;
 /**
-* @deprecated use object.size instead
 * @param {Object<string,any>} obj
 * @return {number}
 */
-const length = (obj) => keys(obj).length;
+const size = (obj) => keys(obj).length;
 /**
 * Calls `Object.prototype.hasOwnProperty`.
 *
 * @param {any} obj
-* @param {string|symbol} key
+* @param {string|number|symbol} key
 * @return {boolean}
 */
 const hasProperty = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key);
 
 //#endregion
-//#region node_modules/lib0/function.js
+//#region node_modules/.pnpm/lib0@0.2.117/node_modules/lib0/function.js
 /**
 * Common functions and function call helpers.
 *
 * @module function
 */
-/**
-* @template T
-*
-* @param {T} a
-* @param {T} b
-* @return {boolean}
-*/
-const equalityStrict = (a, b) => a === b;
 /* c8 ignore start */
 /**
 * @param {any} a
@@ -750,9 +754,9 @@ const equalityStrict = (a, b) => a === b;
 * @return {boolean}
 */
 const equalityDeep = (a, b) => {
-	if (a == null || b == null) return equalityStrict(a, b);
-	if (a.constructor !== b.constructor) return false;
 	if (a === b) return true;
+	if (a == null || b == null || a.constructor !== b.constructor && (a.constructor || Object) !== (b.constructor || Object)) return false;
+	if (a[EqualityTraitSymbol] != null) return a[EqualityTraitSymbol](b);
 	switch (a.constructor) {
 		case ArrayBuffer:
 			a = new Uint8Array(a);
@@ -769,8 +773,9 @@ const equalityDeep = (a, b) => {
 			if (a.size !== b.size) return false;
 			for (const key of a.keys()) if (!b.has(key) || !equalityDeep(a.get(key), b.get(key))) return false;
 			break;
+		case void 0:
 		case Object:
-			if (length(a) !== length(b)) return false;
+			if (size(a) !== size(b)) return false;
 			for (const key in a) if (!hasProperty(a, key) || !equalityDeep(a[key], b[key])) return false;
 			break;
 		case Array:
@@ -785,7 +790,7 @@ const equalityDeep = (a, b) => {
 const isArray = isArray$1;
 
 //#endregion
-//#region node_modules/y-protocols/awareness.js
+//#region node_modules/.pnpm/y-protocols@1.0.7_yjs@13.6.29/node_modules/y-protocols/awareness.js
 /**
 * @module awareness-protocol
 */
@@ -1077,7 +1082,7 @@ var IncomingMessage = class {
 		return writeVarUint8Array(this.encoder, data);
 	}
 	length() {
-		return length$1(this.encoder);
+		return length(this.encoder);
 	}
 };
 
@@ -1091,6 +1096,8 @@ let MessageType = /* @__PURE__ */ function(MessageType) {
 	MessageType[MessageType["Stateless"] = 5] = "Stateless";
 	MessageType[MessageType["CLOSE"] = 7] = "CLOSE";
 	MessageType[MessageType["SyncStatus"] = 8] = "SyncStatus";
+	MessageType[MessageType["Ping"] = 9] = "Ping";
+	MessageType[MessageType["Pong"] = 10] = "Pong";
 	return MessageType;
 }({});
 let WebSocketStatus = /* @__PURE__ */ function(WebSocketStatus) {
@@ -1198,14 +1205,20 @@ var HocuspocusProviderWebsocket = class extends EventEmitter {
 		this.receivedOnOpenPayload = event;
 	}
 	attach(provider) {
-		this.configuration.providerMap.set(provider.configuration.name, provider);
+		const key = provider.effectiveName;
+		const existing = this.configuration.providerMap.get(key);
+		if (existing && existing !== provider) {
+			if (existing.isAuthenticated) throw new Error(`Cannot attach two providers with the same effective name "${key}". Use sessionAwareness: true to multiplex providers with the same document name.`);
+		}
+		this.configuration.providerMap.set(key, provider);
 		if (this.status === WebSocketStatus.Disconnected && this.shouldConnect) this.connect();
 		if (this.receivedOnOpenPayload && this.status === WebSocketStatus.Connected) provider.onOpen(this.receivedOnOpenPayload);
 	}
 	detach(provider) {
-		if (this.configuration.providerMap.has(provider.configuration.name)) {
-			provider.send(CloseMessage, { documentName: provider.configuration.name });
-			this.configuration.providerMap.delete(provider.configuration.name);
+		const key = provider.effectiveName;
+		if (this.configuration.providerMap.has(key)) {
+			provider.send(CloseMessage, { documentName: key });
+			this.configuration.providerMap.delete(key);
 		}
 	}
 	setConfiguration(configuration = {}) {
@@ -1305,8 +1318,21 @@ var HocuspocusProviderWebsocket = class extends EventEmitter {
 	onMessage(event) {
 		this.resolveConnectionAttempt();
 		this.lastMessageReceived = getUnixTime();
-		const documentName = new IncomingMessage(event.data).peekVarString();
-		this.configuration.providerMap.get(documentName)?.onMessage(event);
+		const data = new Uint8Array(event.data);
+		if (data.length === 1 && data[0] === MessageType.Ping) {
+			this.sendPong();
+			return;
+		}
+		const rawKey = new IncomingMessage(data).peekVarString();
+		this.configuration.providerMap.get(rawKey)?.onMessage(event);
+	}
+	/**
+	* Send application-level Pong response to server Ping
+	*/
+	sendPong() {
+		const encoder = createEncoder();
+		writeVarUint(encoder, MessageType.Pong);
+		this.send(toUint8Array(encoder));
 	}
 	resolveConnectionAttempt() {
 		if (this.connectionAttempt) {
@@ -1387,7 +1413,7 @@ var HocuspocusProviderWebsocket = class extends EventEmitter {
 };
 
 //#endregion
-//#region node_modules/y-protocols/sync.js
+//#region node_modules/.pnpm/y-protocols@1.0.7_yjs@13.6.29/node_modules/y-protocols/sync.js
 /**
 * @module sync-protocol
 */
@@ -1455,11 +1481,13 @@ const readSyncStep1 = (decoder, encoder, doc) => writeSyncStep2(encoder, doc, re
 * @param {decoding.Decoder} decoder
 * @param {Y.Doc} doc
 * @param {any} transactionOrigin
+* @param {(error:Error)=>any} [errorHandler]
 */
-const readSyncStep2 = (decoder, doc, transactionOrigin) => {
+const readSyncStep2 = (decoder, doc, transactionOrigin, errorHandler) => {
 	try {
 		yjs.applyUpdate(doc, readVarUint8Array(decoder), transactionOrigin);
 	} catch (error) {
+		if (errorHandler != null) errorHandler(error);
 		console.error("Caught error while handling a Yjs update", error);
 	}
 };
@@ -1477,6 +1505,7 @@ const writeUpdate = (encoder, update) => {
 * @param {decoding.Decoder} decoder
 * @param {Y.Doc} doc
 * @param {any} transactionOrigin
+* @param {(error:Error)=>any} [errorHandler]
 */
 const readUpdate = readSyncStep2;
 /**
@@ -1484,18 +1513,19 @@ const readUpdate = readSyncStep2;
 * @param {encoding.Encoder} encoder The reply message. Does not need to be sent if empty.
 * @param {Y.Doc} doc
 * @param {any} transactionOrigin
+* @param {(error:Error)=>any} [errorHandler] Optional error handler that catches errors when reading Yjs messages.
 */
-const readSyncMessage = (decoder, encoder, doc, transactionOrigin) => {
+const readSyncMessage = (decoder, encoder, doc, transactionOrigin, errorHandler) => {
 	const messageType = readVarUint(decoder);
 	switch (messageType) {
 		case messageYjsSyncStep1:
 			readSyncStep1(decoder, encoder, doc);
 			break;
 		case messageYjsSyncStep2:
-			readSyncStep2(decoder, doc, transactionOrigin);
+			readSyncStep2(decoder, doc, transactionOrigin, errorHandler);
 			break;
 		case messageYjsUpdate:
-			readUpdate(decoder, doc, transactionOrigin);
+			readUpdate(decoder, doc, transactionOrigin, errorHandler);
 			break;
 		default: throw new Error("Unknown message type");
 	}
@@ -1534,15 +1564,13 @@ var MessageReceiver = class {
 			case MessageType.CLOSE:
 				const event = {
 					code: 1e3,
-					reason: readVarString(message.decoder),
-					target: provider.configuration.websocketProvider.webSocket,
-					type: "close"
+					reason: readVarString(message.decoder)
 				};
 				provider.onClose();
 				provider.configuration.onClose({ event });
 				provider.forwardClose({ event });
 				break;
-			default: throw new Error(`Can’t apply message of unknown type: ${type}`);
+			default: console.error(`Can’t apply message of unknown type: ${type}`);
 		}
 		if (message.length() > emptyMessageLength + 1) provider.send(OutgoingMessage, { encoder: message.encoder });
 	}
@@ -1587,6 +1615,10 @@ var MessageSender = class {
 	}
 };
 
+//#endregion
+//#region packages/provider/src/version.ts
+const version = "4.0.0-rc.0";
+
 //#endregion
 //#region packages/provider/src/OutgoingMessages/AuthenticationMessage.ts
 var AuthenticationMessage = class extends OutgoingMessage {
@@ -1600,6 +1632,7 @@ var AuthenticationMessage = class extends OutgoingMessage {
 		writeVarString(this.encoder, args.documentName);
 		writeVarUint(this.encoder, this.type);
 		(0, _hocuspocus_common.writeAuthentication)(this.encoder, args.token);
+		writeVarString(this.encoder, version);
 		return this.encoder;
 	}
 };
@@ -1683,6 +1716,14 @@ var AwarenessError = class extends Error {
 	}
 };
 var HocuspocusProvider = class extends EventEmitter {
+	/**
+	* The effective name used as the first VarString in messages.
+	* When `sessionAwareness` is enabled, returns a composite key (documentName\0sessionId).
+	* Otherwise, returns the plain document name.
+	*/
+	get effectiveName() {
+		return this.configuration.sessionAwareness ? (0, _hocuspocus_common.makeRoutingKey)(this.configuration.name, this.sessionId) : this.configuration.name;
+	}
 	constructor(configuration) {
 		super();
 		this.configuration = {
@@ -1690,6 +1731,7 @@ var HocuspocusProvider = class extends EventEmitter {
 			document: void 0,
 			awareness: void 0,
 			token: null,
+			sessionAwareness: true,
 			forceSyncInterval: false,
 			onAuthenticated: () => null,
 			onAuthenticationFailed: () => null,
@@ -1713,6 +1755,7 @@ var HocuspocusProvider = class extends EventEmitter {
 		this.authorizedScope = void 0;
 		this.manageSocket = false;
 		this._isAttached = false;
+		this.sessionId = Math.random().toString(36).slice(2);
 		this.intervals = { forceSync: null };
 		this.boundDocumentUpdateHandler = this.documentUpdateHandler.bind(this);
 		this.boundAwarenessUpdateHandler = this.awarenessUpdateHandler.bind(this);
@@ -1789,7 +1832,7 @@ var HocuspocusProvider = class extends EventEmitter {
 		this.resetUnsyncedChanges();
 		this.send(SyncStepOneMessage, {
 			document: this.document,
-			documentName: this.configuration.name
+			documentName: this.effectiveName
 		});
 	}
 	pageHide() {
@@ -1801,7 +1844,7 @@ var HocuspocusProvider = class extends EventEmitter {
 	}
 	sendStateless(payload) {
 		this.send(StatelessMessage, {
-			documentName: this.configuration.name,
+			documentName: this.effectiveName,
 			payload
 		});
 	}
@@ -1815,7 +1858,7 @@ var HocuspocusProvider = class extends EventEmitter {
 		}
 		this.send(AuthenticationMessage, {
 			token: token ?? "",
-			documentName: this.configuration.name
+			documentName: this.effectiveName
 		});
 	}
 	documentUpdateHandler(update, origin) {
@@ -1823,7 +1866,7 @@ var HocuspocusProvider = class extends EventEmitter {
 		this.incrementUnsyncedChanges();
 		this.send(UpdateMessage, {
 			update,
-			documentName: this.configuration.name
+			documentName: this.effectiveName
 		});
 	}
 	awarenessUpdateHandler({ added, updated, removed }, origin) {
@@ -1831,7 +1874,7 @@ var HocuspocusProvider = class extends EventEmitter {
 		this.send(AwarenessMessage, {
 			awareness: this.awareness,
 			clients: changedClients,
-			documentName: this.configuration.name
+			documentName: this.effectiveName
 		});
 	}
 	/**
@@ -1873,12 +1916,12 @@ var HocuspocusProvider = class extends EventEmitter {
 		this.resetUnsyncedChanges();
 		this.send(SyncStepOneMessage, {
 			document: this.document,
-			documentName: this.configuration.name
+			documentName: this.effectiveName
 		});
 		if (this.awareness && this.awareness.getLocalState() !== null) this.send(AwarenessMessage, {
 			awareness: this.awareness,
 			clients: [this.document.clientID],
-			documentName: this.configuration.name
+			documentName: this.effectiveName
 		});
 	}
 	send(message, args) {
@@ -1889,8 +1932,8 @@ var HocuspocusProvider = class extends EventEmitter {
 	}
 	onMessage(event) {
 		const message = new IncomingMessage(event.data);
-		const documentName = message.readVarString();
-		message.writeVarString(documentName);
+		const { documentName } = (0, _hocuspocus_common.parseRoutingKey)(message.readVarString());
+		message.writeVarString(this.effectiveName);
 		this.emit("message", {
 			event,
 			message: new IncomingMessage(event.data)