@hocuspocus/provider 3.0.0-rc.0 → 3.0.6-rc.0

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

@@ -1,10 +1,9 @@
 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';
+import { DirectConnection } from './DirectConnection.ts';
+import Document from './Document.ts';
+import type { Server } from './Server.ts';
+import type { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onStoreDocumentPayload } from './types.ts';
 export declare const defaultConfiguration: {
     name: null;
     timeout: number;
@@ -22,7 +21,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 +31,6 @@ export declare class Hocuspocus {
      * Configure Hocuspocus
      */
     configure(configuration: Partial<Configuration>): Hocuspocus;
-    get requiresAuthentication(): boolean;
     /**
      * Get the total number of active documents
      */
@@ -68,19 +65,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/IncomingMessage.d.ts

@@ -1,6 +1,6 @@
 import type { Decoder } from 'lib0/decoding';
 import type { Encoder } from 'lib0/encoding';
-import type { MessageType } from './types.js';
+import type { MessageType } from './types.ts';
 export declare class IncomingMessage {
     /**
      * Access to the received message.
@@ -14,10 +14,11 @@ export declare class IncomingMessage {
     private encoderInternal?;
     constructor(input: any);
     get encoder(): Encoder;
-    readVarUint8Array(): Uint8Array;
+    readVarUint8Array(): Uint8Array<ArrayBufferLike>;
+    peekVarUint8Array(): Uint8Array<ArrayBufferLike>;
     readVarUint(): number;
     readVarString(): string;
-    toUint8Array(): Uint8Array;
+    toUint8Array(): Uint8Array<ArrayBufferLike>;
     writeVarUint(type: MessageType): void;
     writeVarString(string: string): void;
     get length(): number;

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

@@ -1,13 +1,11 @@
-import type Connection from './Connection.js';
-import type { Debugger } from './Debugger.js';
-import type Document from './Document.js';
-import type { IncomingMessage } from './IncomingMessage.js';
+import type Connection from './Connection.ts';
+import type Document from './Document.ts';
+import type { IncomingMessage } from './IncomingMessage.ts';
 export declare class MessageReceiver {
     message: IncomingMessage;
-    logger: Debugger;
     defaultTransactionOrigin?: string;
-    constructor(message: IncomingMessage, logger: Debugger, 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;
+    constructor(message: IncomingMessage, defaultTransactionOrigin?: string);
+    apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): Promise<void>;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): Promise<0 | 1 | 2>;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

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

@@ -1,6 +1,6 @@
 import type { Encoder } from 'lib0/encoding';
 import type { Awareness } from 'y-protocols/awareness';
-import type Document from './Document.js';
+import type Document from './Document.ts';
 export declare class OutgoingMessage {
     encoder: Encoder;
     type?: number;
@@ -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,7 +1,7 @@
 import type { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
-import type { AddressInfo } from 'ws';
 import { WebSocketServer } from 'ws';
-import { Hocuspocus } from './Hocuspocus.js';
+import type { AddressInfo, ServerOptions } from 'ws';
+import { Hocuspocus } from './Hocuspocus.ts';
 import type { Configuration } from './types';
 export interface ServerConfiguration extends Configuration {
     port?: number;
@@ -18,7 +18,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,10 +1,9 @@
-export * from './Connection.js';
-export * from './Debugger.js';
-export * from './Document.js';
-export * from './Hocuspocus.js';
-export * from './IncomingMessage.js';
-export * from './MessageReceiver.js';
-export * from './OutgoingMessage.js';
-export * from './Server.js';
-export * from './types.js';
-export * from './util/debounce.js';
+export * from './Connection.ts';
+export * from './Document.ts';
+export * from './Hocuspocus.ts';
+export * from './IncomingMessage.ts';
+export * from './MessageReceiver.ts';
+export * from './OutgoingMessage.ts';
+export * from './Server.ts';
+export * from './types.ts';
+export * from './util/debounce.ts';

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

@@ -1,9 +1,9 @@
 import type { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
 import type { URLSearchParams } from 'url';
 import type { Awareness } from 'y-protocols/awareness';
-import type Connection from './Connection.js';
-import type Document from './Document.js';
-import type { Hocuspocus } from './Hocuspocus.js';
+import type Connection from './Connection.ts';
+import type Document from './Document.ts';
+import type { Hocuspocus } from './Hocuspocus.ts';
 export declare enum MessageType {
     Unknown = -1,
     Sync = 0,
@@ -23,7 +23,6 @@ export interface AwarenessUpdate {
 }
 export interface ConnectionConfiguration {
     readOnly: boolean;
-    requiresAuthentication: boolean;
     isAuthenticated: boolean;
 }
 export interface Extension {
@@ -39,6 +38,7 @@ export interface Extension {
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     afterLoadDocument?(data: afterLoadDocumentPayload): Promise<any>;
     beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
+    beforeSync?(data: beforeSyncPayload): Promise<any>;
     beforeBroadcastStateless?(data: beforeBroadcastStatelessPayload): Promise<any>;
     onStateless?(payload: onStatelessPayload): Promise<any>;
     onChange?(data: onChangePayload): Promise<any>;
@@ -47,10 +47,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' | 'beforeSync' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'beforeUnloadDocument' | 'afterUnloadDocument' | 'onDestroy';
 export type HookPayloadByName = {
     onConfigure: onConfigurePayload;
     onListen: onListenPayload;
@@ -63,6 +64,7 @@ export type HookPayloadByName = {
     afterLoadDocument: afterLoadDocumentPayload;
     beforeHandleMessage: beforeHandleMessagePayload;
     beforeBroadcastStateless: beforeBroadcastStatelessPayload;
+    beforeSync: beforeSyncPayload;
     onStateless: onStatelessPayload;
     onChange: onChangePayload;
     onStoreDocument: onStoreDocumentPayload;
@@ -71,6 +73,7 @@ export type HookPayloadByName = {
     onRequest: onRequestPayload;
     onDisconnect: onDisconnectPayload;
     afterUnloadDocument: afterUnloadDocumentPayload;
+    beforeUnloadDocument: beforeUnloadDocumentPayload;
     onDestroy: onDestroyPayload;
 };
 export interface Configuration extends Extension {
@@ -130,7 +133,7 @@ export interface onAuthenticatePayload {
     request: IncomingMessage;
     socketId: string;
     token: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onCreateDocumentPayload {
     context: any;
@@ -139,7 +142,7 @@ export interface onCreateDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     context: any;
@@ -149,7 +152,7 @@ export interface onConnectPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface connectedPayload {
     context: any;
@@ -159,8 +162,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 +173,7 @@ export interface onLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface afterLoadDocumentPayload {
     context: any;
@@ -180,7 +183,7 @@ export interface afterLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
@@ -206,6 +209,27 @@ export interface beforeHandleMessagePayload {
     socketId: string;
     connection: Connection;
 }
+export interface beforeSyncPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    connection: Connection;
+    /**
+     * The y-protocols/sync message type
+     * @example
+     * 0: SyncStep1
+     * 1: SyncStep2
+     * 2: YjsUpdate
+     *
+     * @see https://github.com/yjs/y-protocols/blob/master/sync.js#L13-L40
+     */
+    type: number;
+    /**
+     * The payload of the y-sync message.
+     */
+    payload: Uint8Array;
+}
 export interface beforeBroadcastStatelessPayload {
     document: Document;
     documentName: string;
@@ -250,7 +274,7 @@ export interface fetchPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface storePayload extends onStoreDocumentPayload {
     state: Buffer;
@@ -293,6 +317,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/transformer/src/Prosemirror.d.ts

@@ -1,6 +1,6 @@
 import { Doc } from 'yjs';
 import { Schema } from '@tiptap/pm/model';
-import type { Transformer } from './types.js';
+import type { Transformer } from './types.ts';
 declare class Prosemirror implements Transformer {
     defaultSchema: Schema;
     schema(schema: Schema): Prosemirror;

package/dist/packages/transformer/src/Tiptap.d.ts

@@ -1,6 +1,6 @@
 import type { Doc } from 'yjs';
 import type { Extensions } from '@tiptap/core';
-import type { Transformer } from './types.js';
+import type { Transformer } from './types.ts';
 export declare class Tiptap implements Transformer {
     defaultExtensions: Extensions;
     extensions(extensions: Extensions): Tiptap;

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

@@ -1,3 +1,3 @@
-export * from './Prosemirror.js';
-export * from './Tiptap.js';
-export * from './types.js';
+export * from './Prosemirror.ts';
+export * from './Tiptap.ts';
+export * from './types.ts';

package/dist/playground/frontend/app/SocketContext.d.ts

@@ -0,0 +1,2 @@
+import type { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
+export declare const SocketContext: import("react").Context<HocuspocusProviderWebsocket | null>;

package/dist/playground/frontend/next.config.d.ts

@@ -0,0 +1,3 @@
+import type { NextConfig } from "next";
+declare const nextConfig: NextConfig;
+export default nextConfig;

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

@@ -1,9 +1,9 @@
-export * from './createDirectory.js';
-export * from './flushRedis.js';
-export * from './newHocuspocus.js';
-export * from './newHocuspocusProvider.js';
-export * from './newHocuspocusProviderWebsocket.js';
-export * from './randomInteger.js';
-export * from './redisConnectionSettings.js';
-export * from './removeDirectory.js';
-export * from './sleep.js';
+export * from './createDirectory.ts';
+export * from './flushRedis.ts';
+export * from './newHocuspocus.ts';
+export * from './newHocuspocusProvider.ts';
+export * from './newHocuspocusProviderWebsocket.ts';
+export * from './randomInteger.ts';
+export * from './redisConnectionSettings.ts';
+export * from './removeDirectory.ts';
+export * from './sleep.ts';

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.6-rc.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -16,7 +16,7 @@
   "types": "dist/packages/provider/src/index.d.ts",
   "exports": {
     "source": {
-      "import": "./src"
+      "import": "./src/index.ts"
     },
     "default": {
       "import": "./dist/hocuspocus-provider.esm.js",
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^3.0.0-rc.0",
+    "@hocuspocus/common": "^3.0.6-rc.0",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.87",
     "ws": "^8.17.1"