@hocuspocus/common 1.0.0-alpha.10

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

@@ -0,0 +1,63 @@
+/// <reference types="node" />
+import AsyncLock from 'async-lock';
+import WebSocket from 'ws';
+import { IncomingMessage as HTTPIncomingMessage } from 'http';
+import { CloseEvent } from '@hocuspocus/common';
+import Document from './Document';
+import { Debugger } from './Debugger';
+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);
+    /**
+     * Set a callback that will be triggered when the connection is closed
+     */
+    onClose(callback: (document: Document) => void): Connection;
+    /**
+     * Send the given message
+     */
+    send(message: any): void;
+    /**
+     * 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
+     */
+    private sendCurrentAwareness;
+    /**
+     * Handle an incoming message
+     * @private
+     */
+    private handleMessage;
+    /**
+     * Get the underlying connection instance
+     * @deprecated
+     */
+    get instance(): WebSocket;
+    /**
+     * Get the underlying connection instance
+     * @deprecated
+     */
+    get connection(): WebSocket;
+}
+export default Connection;

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

@@ -0,0 +1,14 @@
+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/packages/server/src/Document.d.ts

@@ -0,0 +1,78 @@
+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;
+    };
+    connections: Map<WebSocket, {
+        clients: Set<any>;
+        connection: Connection;
+    }>;
+    name: string;
+    mux: mutex;
+    logger: Debugger;
+    /**
+     * Constructor.
+     */
+    constructor(name: string, logger: Debugger);
+    /**
+     * 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;
+    /**
+     * 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;
+}
+export default Document;

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

@@ -0,0 +1,107 @@
+/// <reference types="node" />
+import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
+import { IncomingMessage, Server as HTTPServer } from 'http';
+import { Configuration, Hook } from './types';
+import Document from './Document';
+import { Debugger } from './Debugger';
+import { onListenPayload } from '.';
+export declare const defaultConfiguration: {
+    name: null;
+    port: number;
+    timeout: number;
+    debounce: number;
+    maxDebounce: number;
+    quiet: 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, documentName: string, 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: Hook, payload: any, callback?: Function | null): Promise<any>;
+    /**
+     * Get parameters by the given request
+     */
+    private static getParameters;
+    /**
+     * Get document name by the given request
+     */
+    private getDocumentNameFromRequest;
+    enableDebugging(): void;
+    enableMessageLogging(): void;
+    disableLogging(): void;
+    disableDebugging(): void;
+    flushMessageLogs(): this;
+    getMessageLogs(): any[];
+}
+export declare const Server: Hocuspocus;

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

@@ -0,0 +1,19 @@
+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;
+    toUint8Array(): Uint8Array;
+    writeVarUint(type: MessageType): void;
+    get length(): number;
+}

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

@@ -0,0 +1,13 @@
+import { Awareness } from 'y-protocols/awareness';
+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): 0 | 1 | 2;
+    applyQueryAwarenessMessage(awareness: Awareness, reply?: (message: Uint8Array) => void): void;
+}

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

@@ -0,0 +1,17 @@
+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();
+    createSyncMessage(): OutgoingMessage;
+    createAwarenessUpdateMessage(awareness: Awareness, changedClients?: Array<any>): OutgoingMessage;
+    writeQueryAwareness(): OutgoingMessage;
+    writeAuthenticated(): OutgoingMessage;
+    writePermissionDenied(reason: string): OutgoingMessage;
+    writeFirstSyncStepFor(document: Document): OutgoingMessage;
+    writeUpdate(update: Uint8Array): OutgoingMessage;
+    toUint8Array(): Uint8Array;
+}

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

@@ -0,0 +1,9 @@
+export * from './Hocuspocus';
+export * from './Connection';
+export * from './Document';
+export * from './IncomingMessage';
+export * from './OutgoingMessage';
+export * from './types';
+export * from './MessageReceiver';
+export * from './Document';
+export * from './Connection';

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

@@ -0,0 +1,216 @@
+/// <reference types="node" />
+import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
+import { URLSearchParams } from 'url';
+import { Socket } from 'net';
+import { Awareness } from 'y-protocols/awareness';
+import Document from './Document';
+import { Hocuspocus } from './Hocuspocus';
+export declare enum MessageType {
+    Unknown = -1,
+    Sync = 0,
+    Awareness = 1,
+    Auth = 2,
+    QueryAwareness = 3
+}
+export interface AwarenessUpdate {
+    added: Array<any>;
+    updated: Array<any>;
+    removed: Array<any>;
+}
+export interface ConnectionConfiguration {
+    readOnly: boolean;
+    requiresAuthentication: boolean;
+    isAuthenticated: boolean;
+}
+export interface Extension {
+    priority?: number;
+    onConfigure?(data: onConfigurePayload): Promise<any>;
+    onListen?(data: onListenPayload): Promise<any>;
+    onUpgrade?(data: onUpgradePayload): Promise<any>;
+    onConnect?(data: onConnectPayload): Promise<any>;
+    connected?(data: connectedPayload): Promise<any>;
+    onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
+    /**
+     * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+     */
+    onCreateDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    afterLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onChange?(data: onChangePayload): Promise<any>;
+    onStoreDocument?(data: onStoreDocumentPayload): Promise<any>;
+    afterStoreDocument?(data: afterStoreDocumentPayload): Promise<any>;
+    onAwarenessUpdate?(data: onAwarenessUpdatePayload): Promise<any>;
+    onRequest?(data: onRequestPayload): Promise<any>;
+    onDisconnect?(data: onDisconnectPayload): Promise<any>;
+    onDestroy?(data: onDestroyPayload): Promise<any>;
+}
+export declare type Hook = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
+/**
+ * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+ */
+'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export interface Configuration extends Extension {
+    /**
+     * A name for the instance, used for logging.
+     */
+    name: string | null;
+    /**
+     * A list of hocuspocus extenions.
+     */
+    extensions: Array<Extension>;
+    /**
+     * The port which the server listens on.
+     */
+    port: number | null;
+    /**
+     * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
+     */
+    timeout: number;
+    /**
+     * Debounces the call of the `onStoreDocument` hook for the given amount of time in ms.
+     * Otherwise every single update would be persisted.
+     */
+    debounce: number;
+    /**
+     * Makes sure to call `onStoreDocument` at least in the given amount of time (ms).
+     */
+    maxDebounce: number;
+    /**
+     * By default, the servers show a start screen. If passed false, the server will start quietly.
+     */
+    quiet: boolean;
+    /**
+     * Function which returns the (customized) document name based on the request
+     */
+    getDocumentName?(data: getDocumentNamePayload): string | Promise<string>;
+}
+export interface getDocumentNamePayload {
+    documentName: string;
+    request: IncomingMessage;
+    requestParameters: URLSearchParams;
+}
+export interface onAuthenticatePayload {
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    token: string;
+    connection: ConnectionConfiguration;
+}
+export interface onConnectPayload {
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
+export interface connectedPayload {
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
+export interface onLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
+export interface afterLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
+export interface onChangePayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    update: Uint8Array;
+    socketId: string;
+}
+export interface onStoreDocumentPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+}
+export interface afterStoreDocumentPayload extends onStoreDocumentPayload {
+}
+export interface onAwarenessUpdatePayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    update: Uint8Array;
+    socketId: string;
+    added: number[];
+    updated: number[];
+    removed: number[];
+    awareness: Awareness;
+    states: StatesArray;
+}
+export declare type StatesArray = {
+    clientId: number;
+    [key: string | number]: any;
+}[];
+export interface storePayload extends onStoreDocumentPayload {
+    state: Buffer;
+}
+export interface onDisconnectPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+}
+export interface onRequestPayload {
+    request: IncomingMessage;
+    response: ServerResponse;
+    instance: Hocuspocus;
+}
+export interface onUpgradePayload {
+    head: any;
+    request: IncomingMessage;
+    socket: Socket;
+    instance: Hocuspocus;
+}
+export interface onListenPayload {
+    port: number;
+}
+export interface onDestroyPayload {
+    instance: Hocuspocus;
+}
+export interface onConfigurePayload {
+    configuration: Configuration;
+    version: string;
+    instance: Hocuspocus;
+}

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

@@ -0,0 +1,11 @@
+import { Doc } from 'yjs';
+import { Schema } from 'prosemirror-model';
+import { Transformer } from './types';
+declare class Prosemirror implements Transformer {
+    defaultSchema: Schema;
+    schema(schema: Schema): Prosemirror;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, schema?: Schema): Doc;
+}
+export declare const ProsemirrorTransformer: Prosemirror;
+export {};

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

@@ -0,0 +1,10 @@
+import { Doc } from 'yjs';
+import { Extensions } from '@tiptap/core/dist/packages/core/src/types';
+import { Transformer } from './types';
+export declare class Tiptap implements Transformer {
+    defaultExtensions: Extensions;
+    extensions(extensions: Extensions): Tiptap;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, extensions?: Extensions): Doc;
+}
+export declare const TiptapTransformer: Tiptap;

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

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

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

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

package/dist/playground/backend/src/default.d.ts

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

package/dist/playground/backend/src/express.d.ts

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

package/dist/playground/backend/src/koa.d.ts

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

package/dist/playground/backend/src/load-document.d.ts

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

package/dist/playground/backend/src/monitor.d.ts

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

package/dist/playground/backend/src/redis.d.ts

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

package/dist/playground/backend/src/slow.d.ts

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

package/dist/playground/backend/src/webhook.d.ts

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

package/dist/tests/extension-logger/onListen.d.ts

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

package/dist/tests/extension-redis/onLoadDocument.d.ts

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

package/dist/tests/extension-redis/onSynced.d.ts

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

package/dist/tests/extension-redis-rewrite/closeConnections.d.ts

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

package/dist/tests/extension-redis-rewrite/getConnectionCount.d.ts

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

package/dist/tests/extension-redis-rewrite/getDocumentsCount.d.ts

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

package/dist/tests/extension-redis-rewrite/onAwarenessChange.d.ts

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

package/dist/tests/extension-redis-rewrite/onChange.d.ts

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

package/dist/tests/extension-redis-rewrite/onStoreDocument.d.ts

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

package/dist/tests/extension-rocksdb/onLoadDocument.d.ts

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

package/dist/tests/extension-throttle/configuration.d.ts

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

package/dist/tests/provider/configuration.d.ts

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

package/dist/tests/provider/observe.d.ts

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

package/dist/tests/provider/observeDeep.d.ts

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

package/dist/tests/provider/onAuthenticated.d.ts

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

package/dist/tests/provider/onAuthenticationFailed.d.ts

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

package/dist/tests/provider/onAwarenessChange.d.ts

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

package/dist/tests/provider/onAwarenessUpdate.d.ts

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

package/dist/tests/provider/onClose.d.ts

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

package/dist/tests/provider/onConnect.d.ts

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