@hocuspocus/provider 2.15.2 → 3.0.4-rc.0

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

@@ -1,12 +1,10 @@
-import Connection from './Connection.js';
-import { Debugger } from './Debugger.js';
-import Document from './Document.js';
-import { IncomingMessage } from './IncomingMessage.js';
+import type Connection from './Connection.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

@@ -1,6 +1,6 @@
-import { Encoder } from 'lib0/encoding';
-import { Awareness } from 'y-protocols/awareness';
-import Document from './Document.js';
+import type { Encoder } from 'lib0/encoding';
+import type { Awareness } from 'y-protocols/awareness';
+import type Document from './Document.js';
 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,13 +1,33 @@
 /// <reference types="node" />
-import { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
-import { ServerOptions, WebSocketServer } from 'ws';
+import type { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
+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 {
+    port?: number;
+    address?: string;
+    stopOnSignals?: boolean;
+}
+export declare const defaultServerConfiguration: {
+    port: number;
+    address: string;
+    stopOnSignals: boolean;
+};
 export declare class Server {
     httpServer: HTTPServer;
     webSocketServer: WebSocketServer;
     hocuspocus: Hocuspocus;
-    constructor(hocuspocus: Hocuspocus, websocketOptions?: ServerOptions);
+    configuration: ServerConfiguration;
+    constructor(configuration?: Partial<ServerConfiguration>, websocketOptions?: ServerOptions);
     setupWebsocketConnection: () => void;
     setupHttpUpgrade: () => void;
     requestHandler: (request: IncomingMessage, response: ServerResponse) => Promise<void>;
+    listen(port?: number, callback?: any): Promise<Hocuspocus>;
+    get address(): AddressInfo;
+    destroy(): Promise<any>;
+    get URL(): string;
+    get webSocketURL(): string;
+    get httpURL(): string;
+    private showStartScreen;
 }

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

@@ -1,9 +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';

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

@@ -1,12 +1,13 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
-import { URLSearchParams } from 'url';
-import { Awareness } from 'y-protocols/awareness';
-import Connection from './Connection.js';
-import Document from './Document.js';
-import { Hocuspocus } from './Hocuspocus.js';
+/// <reference types="node" />
+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';
 export declare enum MessageType {
     Unknown = -1,
     Sync = 0,
@@ -26,7 +27,6 @@ export interface AwarenessUpdate {
 }
 export interface ConnectionConfiguration {
     readOnly: boolean;
-    requiresAuthentication: boolean;
     isAuthenticated: boolean;
 }
 export interface Extension {
@@ -87,14 +87,6 @@ export interface Configuration extends Extension {
      * A list of hocuspocus extensions.
      */
     extensions: Array<Extension>;
-    /**
-     * The port which the server listens on.
-     */
-    port?: number;
-    /**
-     * The address which the server listens on.
-     */
-    address?: string;
     /**
      * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
      */
@@ -120,12 +112,6 @@ export interface Configuration extends Extension {
      * your onStoreDocument is rate-limited.
      */
     unloadImmediately: boolean;
-    /**
-     * the server will gracefully stop if SIGINT, SIGQUIT or SIGTERM is received.
-     *
-     * Set this to false if you don't want that.
-     */
-    stopOnSignals: boolean;
     /**
      * options to pass to the ydoc document
      */
@@ -149,7 +135,7 @@ export interface onAuthenticatePayload {
     request: IncomingMessage;
     socketId: string;
     token: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onCreateDocumentPayload {
     context: any;
@@ -158,7 +144,7 @@ export interface onCreateDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     context: any;
@@ -168,7 +154,7 @@ export interface onConnectPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface connectedPayload {
     context: any;
@@ -178,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;
@@ -189,7 +175,7 @@ export interface onLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface afterLoadDocumentPayload {
     context: any;
@@ -199,7 +185,7 @@ export interface afterLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
@@ -269,7 +255,7 @@ export interface fetchPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface storePayload extends onStoreDocumentPayload {
     state: Buffer;

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { IncomingMessage } from 'http';
+import type { IncomingMessage } from 'http';
 import { URLSearchParams } from 'url';
 /**
    * Get parameters by the given request

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

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

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

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

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

@@ -1,4 +1,4 @@
-import { Doc } from 'yjs';
+import type { Doc } from 'yjs';
 export interface Transformer {
     fromYdoc: (document: Doc, fieldName?: string | Array<string>) => any;
     toYdoc: (document: any, fieldName: string) => Doc;

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

@@ -1,2 +1,2 @@
-import { Hocuspocus, Configuration } from '@hocuspocus/server';
-export declare const newHocuspocus: (options?: Partial<Configuration>) => Promise<Hocuspocus>;
+import type { ServerConfiguration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<ServerConfiguration>) => Promise<import("@hocuspocus/server").Hocuspocus>;

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

@@ -1,3 +1,3 @@
-import { HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
-import { Hocuspocus } from '@hocuspocus/server';
+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>, websocketProvider?: HocuspocusProviderWebsocket) => HocuspocusProvider;

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

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

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

@@ -1,2 +1,2 @@
-import { ExecutionContext } from 'ava';
+import type { ExecutionContext } from 'ava';
 export declare const retryableAssertion: (t: ExecutionContext, recoverableTry: (tt: ExecutionContext) => void) => Promise<void>;

package/package.json

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

package/src/EventEmitter.ts

@@ -1,7 +1,8 @@
 export default class EventEmitter {
-
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
   public callbacks: { [key: string]: Function[] } = {}
 
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
   public on(event: string, fn: Function): this {
     if (!this.callbacks[event]) {
       this.callbacks[event] = []
@@ -22,6 +23,7 @@ export default class EventEmitter {
     return this
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
   public off(event: string, fn?: Function): this {
     const callbacks = this.callbacks[event]