@hocuspocus/common 3.0.0-rc.0 → 3.0.4-rc.0

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

@@ -1,6 +1,8 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import type { IncomingMessage } from 'http';
+import { type CloseEvent } from '@hocuspocus/common';
 import type WebSocket from 'ws';
-import type { Debugger } from './Debugger.js';
 import type Document from './Document.js';
 import type { Hocuspocus } from './Hocuspocus.js';
 import type { onDisconnectPayload } from './types.js';
@@ -15,7 +17,6 @@ export declare class ClientConnection {
     private readonly request;
     private readonly documentProvider;
     private readonly hooks;
-    private readonly debuggerTool;
     private readonly opts;
     private readonly defaultContext;
     private readonly documentConnections;
@@ -23,8 +24,10 @@ export declare class ClientConnection {
     private readonly documentConnectionsEstablished;
     private readonly hookPayloads;
     private readonly callbacks;
-    private readonly closeIdleConnectionTimeout;
     private readonly socketId;
+    timeout: number;
+    pingInterval: NodeJS.Timeout;
+    pongReceived: boolean;
     /**
       * The `ClientConnection` class receives incoming WebSocket connections,
       * runs all hooks:
@@ -37,10 +40,17 @@ export declare class ClientConnection {
       */
     constructor(websocket: WebSocket, request: IncomingMessage, documentProvider: {
         createDocument: Hocuspocus['createDocument'];
-    }, hooks: Hocuspocus['hooks'], debuggerTool: Debugger, opts: {
-        requiresAuthentication: boolean;
+    }, hooks: Hocuspocus['hooks'], opts: {
         timeout: number;
     }, defaultContext?: any);
+    private handleWebsocketClose;
+    close(event?: CloseEvent): void;
+    handlePong: () => void;
+    /**
+     * Check if pong was received and close the connection otherwise
+     * @private
+     */
+    private check;
     /**
      * Set a callback that will be triggered when the connection is closed
      */

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

@@ -1,30 +1,21 @@
+/// <reference types="node" />
 import type { IncomingMessage as HTTPIncomingMessage } from 'http';
-import AsyncLock from 'async-lock';
 import type WebSocket from 'ws';
-import type { CloseEvent } from '@hocuspocus/common';
+import { type CloseEvent } from '@hocuspocus/common';
 import type Document from './Document.js';
-import type { Debugger } from './Debugger.js';
 import type { onStatelessPayload } from './types.js';
 export declare class Connection {
     webSocket: WebSocket;
     context: any;
     document: Document;
-    pingInterval: NodeJS.Timeout;
-    pongReceived: boolean;
     request: HTTPIncomingMessage;
-    timeout: number;
     callbacks: any;
     socketId: string;
-    lock: AsyncLock;
     readOnly: boolean;
-    logger: Debugger;
     /**
      * Constructor.
      */
-    constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly: boolean | undefined, logger: Debugger);
-    boundClose: (event?: CloseEvent) => void;
-    boundHandlePong: () => void;
-    handlePong(): void;
+    constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, socketId: string, context: any, readOnly?: boolean);
     /**
      * Set a callback that will be triggered when the connection is closed
      */
@@ -49,11 +40,6 @@ export declare class Connection {
      * Graceful wrapper around the WebSocket close method.
      */
     close(event?: CloseEvent): void;
-    /**
-     * Check if pong was received and close the connection otherwise
-     * @private
-     */
-    private check;
     /**
      * Send the current document awareness to the client, if any
      * @private

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

@@ -9,6 +9,6 @@ export declare class DirectConnection implements DirectConnectionInterface {
      * Constructor.
      */
     constructor(document: Document, instance: Hocuspocus, context?: any);
-    transact(transaction: (document: Document) => void, transactionOrigin?: any): Promise<void>;
+    transact(transaction: (document: Document) => void): Promise<void>;
     disconnect(): Promise<void>;
 }

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

@@ -1,9 +1,7 @@
 import type WebSocket from 'ws';
 import { Awareness } from 'y-protocols/awareness';
 import { Doc } from 'yjs';
-import type { mutex } from 'lib0/mutex.js';
 import type Connection from './Connection.js';
-import type { Debugger } from './Debugger.js';
 export declare class Document extends Doc {
     awareness: Awareness;
     callbacks: {
@@ -16,14 +14,12 @@ export declare class Document extends Doc {
     }>;
     directConnectionsCount: number;
     name: string;
-    mux: mutex;
-    logger?: Debugger;
     isLoading: boolean;
     isDestroyed: boolean;
     /**
      * Constructor.
      */
-    constructor(name: string, logger?: Debugger, yDocOptions?: object);
+    constructor(name: string, yDocOptions?: object);
     /**
      * Check if the Document (XMLFragment or Map) is empty
      */

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

@@ -1,7 +1,7 @@
+/// <reference types="node" />
 import type { IncomingMessage } from 'http';
 import type WebSocket from 'ws';
 import type { Server } from './Server.js';
-import { Debugger } from './Debugger.js';
 import { DirectConnection } from './DirectConnection.js';
 import Document from './Document.js';
 import type { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onStoreDocumentPayload } from './types.js';
@@ -22,7 +22,6 @@ export declare class Hocuspocus {
     loadingDocuments: Map<string, Promise<Document>>;
     documents: Map<string, Document>;
     server?: Server;
-    debugger: Debugger;
     debouncer: {
         debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => any;
         isDebounced: (id: string) => boolean;
@@ -33,7 +32,6 @@ export declare class Hocuspocus {
      * Configure Hocuspocus
      */
     configure(configuration: Partial<Configuration>): Hocuspocus;
-    get requiresAuthentication(): boolean;
     /**
      * Get the total number of active documents
      */
@@ -68,19 +66,13 @@ export declare class Hocuspocus {
      * Create a new document by the given request
      */
     createDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
-    loadDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
+    loadDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connectionConfig: ConnectionConfiguration, context?: any): Promise<Document>;
     storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload, immediately?: boolean): any;
     /**
      * Run the given hook on all configured extensions.
      * Runs the given callback after each hook.
      */
     hooks<T extends HookName>(name: T, payload: HookPayloadByName[T], callback?: Function | null): Promise<any>;
-    unloadDocument(document: Document): void;
-    enableDebugging(): void;
-    enableMessageLogging(): void;
-    disableLogging(): void;
-    disableDebugging(): void;
-    flushMessageLogs(): this;
-    getMessageLogs(): any[];
+    unloadDocument(document: Document): Promise<any>;
     openDirectConnection(documentName: string, context?: any): Promise<DirectConnection>;
 }

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

@@ -1,12 +1,10 @@
 import type Connection from './Connection.js';
-import type { Debugger } from './Debugger.js';
 import type Document from './Document.js';
 import type { IncomingMessage } from './IncomingMessage.js';
 export declare class MessageReceiver {
     message: IncomingMessage;
-    logger: Debugger;
     defaultTransactionOrigin?: string;
-    constructor(message: IncomingMessage, logger: Debugger, 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;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;

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

@@ -17,5 +17,6 @@ export declare class OutgoingMessage {
     writeStateless(payload: string): OutgoingMessage;
     writeBroadcastStateless(payload: string): OutgoingMessage;
     writeSyncStatus(updateSaved: boolean): OutgoingMessage;
+    writeCloseMessage(reason: string): OutgoingMessage;
     toUint8Array(): Uint8Array;
 }

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

@@ -1,6 +1,7 @@
+/// <reference types="node" />
 import type { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
-import type { AddressInfo } from 'ws';
 import { WebSocketServer } from 'ws';
+import type { AddressInfo, ServerOptions } from 'ws';
 import { Hocuspocus } from './Hocuspocus.js';
 import type { Configuration } from './types';
 export interface ServerConfiguration extends Configuration {
@@ -18,7 +19,7 @@ export declare class Server {
     webSocketServer: WebSocketServer;
     hocuspocus: Hocuspocus;
     configuration: ServerConfiguration;
-    constructor(configuration?: Partial<ServerConfiguration>);
+    constructor(configuration?: Partial<ServerConfiguration>, websocketOptions?: ServerOptions);
     setupWebsocketConnection: () => void;
     setupHttpUpgrade: () => void;
     requestHandler: (request: IncomingMessage, response: ServerResponse) => Promise<void>;

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

@@ -1,5 +1,4 @@
 export * from './Connection.js';
-export * from './Debugger.js';
 export * from './Document.js';
 export * from './Hocuspocus.js';
 export * from './IncomingMessage.js';

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

@@ -1,3 +1,7 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import type { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
 import type { URLSearchParams } from 'url';
 import type { Awareness } from 'y-protocols/awareness';
@@ -10,7 +14,7 @@ export declare enum MessageType {
     Awareness = 1,
     Auth = 2,
     QueryAwareness = 3,
-    SyncReply = 4,// same as Sync, but won't trigger another 'SyncStep1'
+    SyncReply = 4,
     Stateless = 5,
     BroadcastStateless = 6,
     CLOSE = 7,
@@ -23,7 +27,6 @@ export interface AwarenessUpdate {
 }
 export interface ConnectionConfiguration {
     readOnly: boolean;
-    requiresAuthentication: boolean;
     isAuthenticated: boolean;
 }
 export interface Extension {
@@ -47,10 +50,11 @@ export interface Extension {
     onAwarenessUpdate?(data: onAwarenessUpdatePayload): Promise<any>;
     onRequest?(data: onRequestPayload): Promise<any>;
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
+    beforeUnloadDocument?(data: beforeUnloadDocumentPayload): Promise<any>;
     afterUnloadDocument?(data: afterUnloadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'afterUnloadDocument' | 'onDestroy';
+export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'beforeUnloadDocument' | 'afterUnloadDocument' | 'onDestroy';
 export type HookPayloadByName = {
     onConfigure: onConfigurePayload;
     onListen: onListenPayload;
@@ -71,6 +75,7 @@ export type HookPayloadByName = {
     onRequest: onRequestPayload;
     onDisconnect: onDisconnectPayload;
     afterUnloadDocument: afterUnloadDocumentPayload;
+    beforeUnloadDocument: beforeUnloadDocumentPayload;
     onDestroy: onDestroyPayload;
 };
 export interface Configuration extends Extension {
@@ -130,7 +135,7 @@ export interface onAuthenticatePayload {
     request: IncomingMessage;
     socketId: string;
     token: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onCreateDocumentPayload {
     context: any;
@@ -139,7 +144,7 @@ export interface onCreateDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     context: any;
@@ -149,7 +154,7 @@ export interface onConnectPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface connectedPayload {
     context: any;
@@ -159,8 +164,8 @@ export interface connectedPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
-    connectionInstance: Connection;
+    connectionConfig: ConnectionConfiguration;
+    connection: Connection;
 }
 export interface onLoadDocumentPayload {
     context: any;
@@ -170,7 +175,7 @@ export interface onLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface afterLoadDocumentPayload {
     context: any;
@@ -180,7 +185,7 @@ export interface afterLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
@@ -250,7 +255,7 @@ export interface fetchPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface storePayload extends onStoreDocumentPayload {
     state: Buffer;
@@ -293,6 +298,10 @@ export interface afterUnloadDocumentPayload {
     instance: Hocuspocus;
     documentName: string;
 }
+export interface beforeUnloadDocumentPayload {
+    instance: Hocuspocus;
+    documentName: string;
+}
 export interface DirectConnection {
     transact(transaction: (document: Document) => void): Promise<void>;
     disconnect(): void;

package/dist/packages/server/src/util/getParameters.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import type { IncomingMessage } from 'http';
 import { URLSearchParams } from 'url';
 /**

package/dist/tests/utils/newHocuspocusProvider.d.ts

@@ -1,3 +1,3 @@
-import { HocuspocusProvider, type HocuspocusProviderConfiguration, type HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
+import { HocuspocusProvider, type HocuspocusProviderConfiguration, type HocuspocusProviderWebsocket, type HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
 import type { Hocuspocus } from '@hocuspocus/server';
-export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<HocuspocusProviderConfiguration>, websocketOptions?: Partial<HocuspocusProviderWebsocketConfiguration>) => HocuspocusProvider;
+export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<HocuspocusProviderConfiguration>, websocketOptions?: Partial<HocuspocusProviderWebsocketConfiguration>, websocketProvider?: HocuspocusProviderWebsocket) => HocuspocusProvider;

package/dist/tests/utils/newHocuspocusProviderWebsocket.d.ts

@@ -1,4 +1,4 @@
 import type { HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
 import { HocuspocusProviderWebsocket } from '@hocuspocus/provider';
 import type { Hocuspocus } from '@hocuspocus/server';
-export declare const newHocuspocusProviderWebsocket: (hocuspocus: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, "url">>) => HocuspocusProviderWebsocket;
+export declare const newHocuspocusProviderWebsocket: (hocuspocus: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, 'url'>>) => HocuspocusProviderWebsocket;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/common",
   "description": "shared code for multiple Hocuspocus packages",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.4-rc.0",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus"

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

@@ -1,64 +0,0 @@
-import type { AbstractType, YArrayEvent } from 'yjs';
-import * as Y from 'yjs';
-import type { HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
-import { HocuspocusProvider } from './HocuspocusProvider.js';
-import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
-import type { TCollabComment, TCollabThread, THistoryVersion } from './types.js';
-export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>) & Pick<AdditionalTiptapCollabProviderConfiguration, 'user'>;
-export interface AdditionalTiptapCollabProviderConfiguration {
-    /**
-     * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
-     */
-    appId?: string;
-    /**
-     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
-     */
-    baseUrl?: string;
-    websocketProvider?: TiptapCollabProviderWebsocket;
-    user?: string;
-}
-export declare class TiptapCollabProvider extends HocuspocusProvider {
-    tiptapCollabConfigurationPrefix: string;
-    userData?: Y.PermanentUserData;
-    constructor(configuration: TiptapCollabProviderConfiguration);
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    createVersion(name?: string): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    revertToVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     *
-     * The server will reply with a stateless message (THistoryVersionPreviewEvent)
-     */
-    previewVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    getVersions(): THistoryVersion[];
-    watchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['observe']>[0]): void;
-    unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['unobserve']>[0]): void;
-    isAutoVersioning(): boolean;
-    enableAutoVersioning(): 1;
-    disableAutoVersioning(): 0;
-    private getYThreads;
-    getThreads<Data, CommentData>(): TCollabThread<Data, CommentData>[];
-    private getThreadIndex;
-    getThread<Data, CommentData>(id: string): TCollabThread<Data, CommentData> | null;
-    private getYThread;
-    createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'comments'>): TCollabThread;
-    updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data'> & {
-        resolvedAt: TCollabThread['resolvedAt'] | null;
-    }>): TCollabThread;
-    deleteThread(id: TCollabThread['id']): void;
-    getThreadComments(threadId: TCollabThread['id']): TCollabComment[] | null;
-    getThreadComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabComment | null;
-    addComment(threadId: TCollabThread['id'], data: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>): TCollabThread;
-    updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>): TCollabThread;
-    deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabThread | null | undefined;
-    watchThreads(callback: () => void): void;
-    unwatchThreads(callback: () => void): void;
-}

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

@@ -1,20 +0,0 @@
-import type { CompleteHocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket.js';
-import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket.js';
-export type TiptapCollabProviderWebsocketConfiguration = Partial<CompleteHocuspocusProviderWebsocketConfiguration> & AdditionalTiptapCollabProviderWebsocketConfiguration;
-export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
-    /**
-     * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
-     */
-    appId?: string;
-    /**
-     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
-     */
-    baseUrl?: string;
-    /**
-     * Only fill this if you are using Tiptap Collab HA.
-     */
-    shardKey?: string;
-}
-export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
-    constructor(configuration: TiptapCollabProviderWebsocketConfiguration);
-}

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

@@ -1,14 +0,0 @@
-export declare class Debugger {
-    logs: any[];
-    listen: boolean;
-    output: boolean;
-    enable(): void;
-    disable(): void;
-    verbose(): void;
-    quiet(): void;
-    log(message: any): this;
-    flush(): this;
-    get(): {
-        logs: any[];
-    };
-}

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

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

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

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