@hocuspocus/provider 2.0.6 → 2.1.0

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

@@ -0,0 +1,13 @@
+import Document from './Document.js';
+import type { Hocuspocus } from './Hocuspocus.js';
+export declare class DirectConnection {
+    document: Document | null;
+    instance: Hocuspocus;
+    context: any;
+    /**
+     * Constructor.
+     */
+    constructor(document: Document, instance: Hocuspocus, context?: any);
+    transact(transaction: (document: Document) => void): Promise<void>;
+    disconnect(): void;
+}

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

@@ -1,88 +1,91 @@
-import WebSocket from 'ws';
-import { Awareness } from 'y-protocols/awareness';
-import { Doc } from 'yjs';
-import { mutex } from 'lib0/mutex.js';
-import Connection from './Connection';
-import { Debugger } from './Debugger';
-export declare class Document extends Doc {
-    awareness: Awareness;
-    callbacks: {
-        onUpdate: (document: Document, connection: Connection, update: Uint8Array) => void;
-        beforeBroadcastStateless: (document: Document, stateless: string) => void;
-    };
-    connections: Map<WebSocket, {
-        clients: Set<any>;
-        connection: Connection;
-    }>;
-    name: string;
-    mux: mutex;
-    logger: Debugger;
-    isLoading: boolean;
-    /**
-     * Constructor.
-     */
-    constructor(name: string, logger: Debugger, yDocOptions: {});
-    /**
-     * Check if the Document is empty
-     */
-    isEmpty(fieldName: string): boolean;
-    /**
-     * Merge the given document(s) into this one
-     */
-    merge(documents: Doc | Array<Doc>): Document;
-    /**
-     * Set a callback that will be triggered when the document is updated
-     */
-    onUpdate(callback: (document: Document, connection: Connection, update: Uint8Array) => void): Document;
-    /**
-     * Set a callback that will be triggered before a stateless message is broadcasted
-     */
-    beforeBroadcastStateless(callback: (document: Document, stateless: string) => void): Document;
-    /**
-     * Register a connection and a set of clients on this document keyed by the
-     * underlying websocket connection
-     */
-    addConnection(connection: Connection): Document;
-    /**
-     * Is the given connection registered on this document
-     */
-    hasConnection(connection: Connection): boolean;
-    /**
-     * Remove the given connection from this document
-     */
-    removeConnection(connection: Connection): Document;
-    /**
-     * Get the number of active connections for this document
-     */
-    getConnectionsCount(): number;
-    /**
-     * Get an array of registered connections
-     */
-    getConnections(): Array<Connection>;
-    /**
-     * Get the client ids for the given connection instance
-     */
-    getClients(connectionInstance: WebSocket): Set<any>;
-    /**
-     * Has the document awareness states
-     */
-    hasAwarenessStates(): boolean;
-    /**
-     * Apply the given awareness update
-     */
-    applyAwarenessUpdate(connection: Connection, update: Uint8Array): Document;
-    /**
-     * Handle an awareness update and sync changes to clients
-     * @private
-     */
-    private handleAwarenessUpdate;
-    /**
-     * Handle an updated document and sync changes to clients
-     */
-    private handleUpdate;
-    /**
-     * Broadcast stateless message to all connections
-     */
-    broadcastStateless(payload: string): void;
-}
-export default Document;
+import WebSocket from 'ws';
+import { Awareness } from 'y-protocols/awareness';
+import { Doc } from 'yjs';
+import { mutex } from 'lib0/mutex.js';
+import Connection from './Connection.js';
+import { Debugger } from './Debugger.js';
+export declare class Document extends Doc {
+    awareness: Awareness;
+    callbacks: {
+        onUpdate: (document: Document, connection: Connection, update: Uint8Array) => void;
+        beforeBroadcastStateless: (document: Document, stateless: string) => void;
+    };
+    connections: Map<WebSocket, {
+        clients: Set<any>;
+        connection: Connection;
+    }>;
+    directConnectionsCount: number;
+    name: string;
+    mux: mutex;
+    logger: Debugger;
+    isLoading: boolean;
+    /**
+     * Constructor.
+     */
+    constructor(name: string, logger: Debugger, yDocOptions: {});
+    /**
+     * Check if the Document is empty
+     */
+    isEmpty(fieldName: string): boolean;
+    /**
+     * Merge the given document(s) into this one
+     */
+    merge(documents: Doc | Array<Doc>): Document;
+    /**
+     * Set a callback that will be triggered when the document is updated
+     */
+    onUpdate(callback: (document: Document, connection: Connection, update: Uint8Array) => void): Document;
+    /**
+     * Set a callback that will be triggered before a stateless message is broadcasted
+     */
+    beforeBroadcastStateless(callback: (document: Document, stateless: string) => void): Document;
+    /**
+     * Register a connection and a set of clients on this document keyed by the
+     * underlying websocket connection
+     */
+    addConnection(connection: Connection): Document;
+    /**
+     * Is the given connection registered on this document
+     */
+    hasConnection(connection: Connection): boolean;
+    /**
+     * Remove the given connection from this document
+     */
+    removeConnection(connection: Connection): Document;
+    addDirectConnection(): Document;
+    removeDirectConnection(): Document;
+    /**
+     * Get the number of active connections for this document
+     */
+    getConnectionsCount(): number;
+    /**
+     * Get an array of registered connections
+     */
+    getConnections(): Array<Connection>;
+    /**
+     * Get the client ids for the given connection instance
+     */
+    getClients(connectionInstance: WebSocket): Set<any>;
+    /**
+     * Has the document awareness states
+     */
+    hasAwarenessStates(): boolean;
+    /**
+     * Apply the given awareness update
+     */
+    applyAwarenessUpdate(connection: Connection, update: Uint8Array): Document;
+    /**
+     * Handle an awareness update and sync changes to clients
+     * @private
+     */
+    private handleAwarenessUpdate;
+    /**
+     * Handle an updated document and sync changes to clients
+     */
+    private handleUpdate;
+    /**
+     * Broadcast stateless message to all connections
+     */
+    broadcastStateless(payload: string): void;
+}
+export default Document;

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

@@ -1,108 +1,111 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IncomingMessage, Server as HTTPServer } from 'http';
-import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
-import { Configuration, HookName, HookPayload, onListenPayload } from './types';
-import Document from './Document';
-import { Debugger } from './Debugger';
-export declare const defaultConfiguration: {
-    name: null;
-    port: number;
-    address: string;
-    timeout: number;
-    debounce: number;
-    maxDebounce: number;
-    quiet: boolean;
-    yDocOptions: {
-        gc: boolean;
-        gcFilter: () => boolean;
-    };
-};
-/**
- * Hocuspocus Server
- */
-export declare class Hocuspocus {
-    configuration: Configuration;
-    documents: Map<string, Document>;
-    httpServer?: HTTPServer;
-    webSocketServer?: WebSocketServer;
-    debugger: Debugger;
-    constructor(configuration?: Partial<Configuration>);
-    /**
-     * Configure the server
-     */
-    configure(configuration: Partial<Configuration>): Hocuspocus;
-    get requiresAuthentication(): boolean;
-    /**
-     * Start the server
-     */
-    listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any): Promise<Hocuspocus>;
-    get address(): AddressInfo;
-    get URL(): string;
-    get webSocketURL(): string;
-    get httpURL(): string;
-    private showStartScreen;
-    /**
-     * Get the total number of active documents
-     */
-    getDocumentsCount(): number;
-    /**
-     * Get the total number of active connections
-     */
-    getConnectionsCount(): number;
-    /**
-     * Force close one or more connections
-     */
-    closeConnections(documentName?: string): void;
-    /**
-     * Destroy the server
-     */
-    destroy(): Promise<any>;
-    /**
-     * The `handleConnection` method receives incoming WebSocket connections,
-     * runs all hooks:
-     *
-     *  - onConnect for all connections
-     *  - onAuthenticate only if required
-     *
-     * … and if nothings fails it’ll fully establish the connection and
-     * load the Document then.
-     */
-    handleConnection(incoming: WebSocket, request: IncomingMessage, context?: any): void;
-    /**
-     * Handle update of the given document
-     */
-    private handleDocumentUpdate;
-    timers: Map<string, {
-        timeout: NodeJS.Timeout;
-        start: number;
-    }>;
-    /**
-     * debounce the given function, using the given identifier
-     */
-    debounce(id: string, func: Function, immediately?: boolean): void;
-    /**
-     * Create a new document by the given request
-     */
-    private createDocument;
-    /**
-     * Create a new connection by the given request and document
-     */
-    private createConnection;
-    /**
-     * Run the given hook on all configured extensions.
-     * Runs the given callback after each hook.
-     */
-    hooks(name: HookName, payload: HookPayload, callback?: Function | null): Promise<any>;
-    /**
-     * Get parameters by the given request
-     */
-    private static getParameters;
-    enableDebugging(): void;
-    enableMessageLogging(): void;
-    disableLogging(): void;
-    disableDebugging(): void;
-    flushMessageLogs(): this;
-    getMessageLogs(): any[];
-}
-export declare const Server: Hocuspocus;
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingMessage, Server as HTTPServer } from 'http';
+import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
+import { Configuration, HookName, HookPayload, onListenPayload, onStoreDocumentPayload } from './types.js';
+import Document from './Document.js';
+import { Debugger } from './Debugger.js';
+import { DirectConnection } from './DirectConnection.js';
+export declare const defaultConfiguration: {
+    name: null;
+    port: number;
+    address: string;
+    timeout: number;
+    debounce: number;
+    maxDebounce: number;
+    quiet: boolean;
+    yDocOptions: {
+        gc: boolean;
+        gcFilter: () => boolean;
+    };
+};
+/**
+ * Hocuspocus Server
+ */
+export declare class Hocuspocus {
+    configuration: Configuration;
+    documents: Map<string, Document>;
+    httpServer?: HTTPServer;
+    webSocketServer?: WebSocketServer;
+    debugger: Debugger;
+    constructor(configuration?: Partial<Configuration>);
+    /**
+     * Configure the server
+     */
+    configure(configuration: Partial<Configuration>): Hocuspocus;
+    get requiresAuthentication(): boolean;
+    /**
+     * Start the server
+     */
+    listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any): Promise<Hocuspocus>;
+    get address(): AddressInfo;
+    get URL(): string;
+    get webSocketURL(): string;
+    get httpURL(): string;
+    private showStartScreen;
+    /**
+     * Get the total number of active documents
+     */
+    getDocumentsCount(): number;
+    /**
+     * Get the total number of active connections
+     */
+    getConnectionsCount(): number;
+    /**
+     * Force close one or more connections
+     */
+    closeConnections(documentName?: string): void;
+    /**
+     * Destroy the server
+     */
+    destroy(): Promise<any>;
+    /**
+     * The `handleConnection` method receives incoming WebSocket connections,
+     * runs all hooks:
+     *
+     *  - onConnect for all connections
+     *  - onAuthenticate only if required
+     *
+     * … and if nothings fails it’ll fully establish the connection and
+     * load the Document then.
+     */
+    handleConnection(incoming: WebSocket, request: IncomingMessage, context?: any): void;
+    /**
+     * Handle update of the given document
+     */
+    private handleDocumentUpdate;
+    timers: Map<string, {
+        timeout: NodeJS.Timeout;
+        start: number;
+    }>;
+    /**
+     * debounce the given function, using the given identifier
+     */
+    debounce(id: string, func: Function, immediately?: boolean): void;
+    /**
+     * Create a new document by the given request
+     */
+    private createDocument;
+    /**
+     * Create a new connection by the given request and document
+     */
+    private createConnection;
+    storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload): void;
+    /**
+     * Run the given hook on all configured extensions.
+     * Runs the given callback after each hook.
+     */
+    hooks(name: HookName, payload: HookPayload, callback?: Function | null): Promise<any>;
+    /**
+     * Get parameters by the given request
+     */
+    private static getParameters;
+    enableDebugging(): void;
+    enableMessageLogging(): void;
+    disableLogging(): void;
+    disableDebugging(): void;
+    flushMessageLogs(): this;
+    getMessageLogs(): any[];
+    openDirectConnection(documentName: string, context?: any): Promise<DirectConnection>;
+}
+export declare const Server: Hocuspocus;

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

@@ -1,21 +1,21 @@
-import { Decoder } from 'lib0/decoding';
-import { Encoder } from 'lib0/encoding';
-import { MessageType } from './types';
-export declare class IncomingMessage {
-    /**
-     * Access to the received message.
-     */
-    decoder: Decoder;
-    /**
-     * Access to the reply.
-     */
-    encoder: Encoder;
-    constructor(input: any);
-    readVarUint8Array(): Uint8Array;
-    readVarUint(): number;
-    readVarString(): string;
-    toUint8Array(): Uint8Array;
-    writeVarUint(type: MessageType): void;
-    writeVarString(string: string): void;
-    get length(): number;
-}
+import { Decoder } from 'lib0/decoding';
+import { Encoder } from 'lib0/encoding';
+import { MessageType } from './types.js';
+export declare class IncomingMessage {
+    /**
+     * Access to the received message.
+     */
+    decoder: Decoder;
+    /**
+     * Access to the reply.
+     */
+    encoder: Encoder;
+    constructor(input: any);
+    readVarUint8Array(): Uint8Array;
+    readVarUint(): number;
+    readVarString(): string;
+    toUint8Array(): Uint8Array;
+    writeVarUint(type: MessageType): void;
+    writeVarString(string: string): void;
+    get length(): number;
+}

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

@@ -1,12 +1,12 @@
-import Connection from './Connection';
-import { IncomingMessage } from './IncomingMessage';
-import { Debugger } from './Debugger';
-import Document from './Document';
-export declare class MessageReceiver {
-    message: IncomingMessage;
-    logger: Debugger;
-    constructor(message: IncomingMessage, logger: Debugger);
-    apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
-    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
-    applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
-}
+import Connection from './Connection.js';
+import { IncomingMessage } from './IncomingMessage.js';
+import { Debugger } from './Debugger.js';
+import Document from './Document.js';
+export declare class MessageReceiver {
+    message: IncomingMessage;
+    logger: Debugger;
+    constructor(message: IncomingMessage, logger: Debugger);
+    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,20 +1,20 @@
-import { Encoder } from 'lib0/encoding';
-import { Awareness } from 'y-protocols/awareness';
-import Document from './Document';
-export declare class OutgoingMessage {
-    encoder: Encoder;
-    type?: number;
-    category?: string;
-    constructor(documentName: string);
-    createSyncMessage(): OutgoingMessage;
-    createSyncReplyMessage(): OutgoingMessage;
-    createAwarenessUpdateMessage(awareness: Awareness, changedClients?: Array<any>): OutgoingMessage;
-    writeQueryAwareness(): OutgoingMessage;
-    writeAuthenticated(): OutgoingMessage;
-    writePermissionDenied(reason: string): OutgoingMessage;
-    writeFirstSyncStepFor(document: Document): OutgoingMessage;
-    writeUpdate(update: Uint8Array): OutgoingMessage;
-    writeStateless(payload: string): OutgoingMessage;
-    writeBroadcastStateless(payload: string): OutgoingMessage;
-    toUint8Array(): Uint8Array;
-}
+import { Encoder } from 'lib0/encoding';
+import { Awareness } from 'y-protocols/awareness';
+import Document from './Document.js';
+export declare class OutgoingMessage {
+    encoder: Encoder;
+    type?: number;
+    category?: string;
+    constructor(documentName: string);
+    createSyncMessage(): OutgoingMessage;
+    createSyncReplyMessage(): OutgoingMessage;
+    createAwarenessUpdateMessage(awareness: Awareness, changedClients?: Array<any>): OutgoingMessage;
+    writeQueryAwareness(): OutgoingMessage;
+    writeAuthenticated(readonly: boolean): OutgoingMessage;
+    writePermissionDenied(reason: string): OutgoingMessage;
+    writeFirstSyncStepFor(document: Document): OutgoingMessage;
+    writeUpdate(update: Uint8Array): OutgoingMessage;
+    writeStateless(payload: string): OutgoingMessage;
+    writeBroadcastStateless(payload: string): OutgoingMessage;
+    toUint8Array(): Uint8Array;
+}

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

@@ -1,8 +1,8 @@
-export * from './Connection';
-export * from './Debugger';
-export * from './Document';
-export * from './Hocuspocus';
-export * from './IncomingMessage';
-export * from './MessageReceiver';
-export * from './OutgoingMessage';
-export * from './types';
+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 './types.js';