@hocuspocus/server/src/DirectConnection.ts

plug & play collaboration backend

import { URLSearchParams } from "node:url";
import type Document from "./Document.ts";
import type { Hocuspocus } from "./Hocuspocus.ts";
import type { DirectConnection as DirectConnectionInterface } from "./types.ts";

export class DirectConnection implements DirectConnectionInterface {
	document: Document | null = null;

	instance!: Hocuspocus;

	context: any;

	/**
	 * Constructor.
	 */
	constructor(document: Document, instance: Hocuspocus, context?: any) {
		this.document = document;
		this.instance = instance;
		this.context = context;

		this.document.addDirectConnection();
	}

	async transact(transaction: (document: Document) => void) {
		if (!this.document) {
			throw new Error("direct connection closed");
		}

		transaction(this.document);

		await this.instance.storeDocumentHooks(
			this.document,
			{
				clientsCount: this.document.getConnectionsCount(),
				context: this.context,
				document: this.document,
				documentName: this.document.name,
				instance: this.instance,
				requestHeaders: {},
				requestParameters: new URLSearchParams(),
				socketId: "server",
			},
			true,
		);
	}

	async disconnect() {
		if (this.document) {
			this.document?.removeDirectConnection();

			await this.instance.storeDocumentHooks(
				this.document,
				{
					clientsCount: this.document.getConnectionsCount(),
					context: this.context,
					document: this.document,
					documentName: this.document.name,
					instance: this.instance,
					requestHeaders: {},
					requestParameters: new URLSearchParams(),
					socketId: "server",
				},
				true,
			);

			// If the direct connection was the only connection to the document
			// then we should trigger the onDisconnect hook for
			// this doc and unload the document
			if (this.document.getConnectionsCount() === 0) {
				await this.instance.hooks("onDisconnect", {
					instance: this.instance,
					clientsCount: this.document.getConnectionsCount(),
					context: this.context,
					document: this.document,
					socketId: "server",
					documentName: this.document.name,
					requestHeaders: {},
					requestParameters: new URLSearchParams(),
				});

				await this.instance.unloadDocument(this.document);
			}

			this.document = null;
		}
	}
}