@hocuspocus/extension-database 1.0.0-alpha.5 → 1.0.0-alpha.6

package/dist/hocuspocus-database.cjs

@@ -33,8 +33,8 @@ class Database {
          * Default configuration
          */
         this.configuration = {
-            fetchUpdates: async () => [],
-            storeUpdate: async () => null,
+            fetch: async () => null,
+            store: async () => null,
         };
         this.configuration = {
             ...this.configuration,
@@ -45,20 +45,20 @@ class Database {
      * Get stored data from the database.
      */
     async onLoadDocument({ document, documentName }) {
-        const updates = await this.configuration.fetchUpdates({ documentName });
-        if (updates && updates.length) {
-            updates.forEach((update) => {
-                Y__namespace.applyUpdate(document, update);
-            });
+        const update = await this.configuration.fetch({ documentName });
+        if (update) {
+            Y__namespace.applyUpdate(document, update);
         }
         return document;
     }
     /**
      * Store new updates in the database.
      */
-    async onChange({ document, documentName }) {
-        const update = Buffer.from(Y__namespace.encodeStateAsUpdate(document));
-        return this.configuration.storeUpdate({ update, documentName });
+    async onStoreDocument(data) {
+        return this.configuration.store({
+            ...data,
+            state: Buffer.from(Y__namespace.encodeStateAsUpdate(data.document)),
+        });
     }
 }
 

package/dist/hocuspocus-database.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-database.cjs","sources":["../src/Database.ts"],"sourcesContent":["import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetchUpdates: ({ documentName }: { documentName: string}) => Promise<Uint8Array[]>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  storeUpdate: ({ update, documentName }: { update: Buffer, documentName: string}) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetchUpdates: async () => [],\n    storeUpdate: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {\n    const updates = await this.configuration.fetchUpdates({ documentName })\n\n    if (updates && updates.length) {\n      updates.forEach((update: any) => {\n        Y.applyUpdate(document, update)\n      })\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onChange({ document, documentName }: onChangePayload) {\n    const update = Buffer.from(\n      Y.encodeStateAsUpdate(document),\n    )\n\n    return this.configuration.storeUpdate({ update, documentName })\n  }\n}\n"],"names":["Y"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;MAea,QAAQ;;;;IAYnB,YAAY,aAA6C;;;;QARzD,kBAAa,GAA0B;YACrC,YAAY,EAAE,YAAY,EAAE;YAC5B,WAAW,EAAE,YAAY,IAAI;SAC9B,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB;QACpE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;QAEvE,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,OAAO,CAAC,CAAC,MAAW;gBAC1BA,YAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;aAChC,CAAC,CAAA;SACH;QAED,OAAO,QAAQ,CAAA;KAChB;;;;IAKD,MAAM,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAmB;QACxD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CACxBA,YAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAChC,CAAA;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;KAChE;;;;;"}
+{"version":3,"file":"hocuspocus-database.cjs","sources":["../src/Database.ts"],"sourcesContent":["import {\n  Extension, onChangePayload, onLoadDocumentPayload, storePayload,\n} from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetch: ({ documentName }: { documentName: string}) => Promise<Uint8Array | null>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  store: (data: storePayload) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetch: async () => null,\n    store: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch({ documentName })\n\n    if (update) {\n      Y.applyUpdate(document, update)\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onStoreDocument(data: onChangePayload) {\n    return this.configuration.store({\n      ...data,\n      state: Buffer.from(\n        Y.encodeStateAsUpdate(data.document),\n      ),\n    })\n  }\n}\n"],"names":["Y"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;MAiBa,QAAQ;;;;IAYnB,YAAY,aAA6C;;;;QARzD,kBAAa,GAA0B;YACrC,KAAK,EAAE,YAAY,IAAI;YACvB,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;QAE/D,IAAI,MAAM,EAAE;YACVA,YAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;SAChC;QAED,OAAO,QAAQ,CAAA;KAChB;;;;IAKD,MAAM,eAAe,CAAC,IAAqB;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YAC9B,GAAG,IAAI;YACP,KAAK,EAAE,MAAM,CAAC,IAAI,CAChBA,YAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;SACF,CAAC,CAAA;KACH;;;;;"}

package/dist/hocuspocus-database.esm.js

@@ -9,8 +9,8 @@ class Database {
          * Default configuration
          */
         this.configuration = {
-            fetchUpdates: async () => [],
-            storeUpdate: async () => null,
+            fetch: async () => null,
+            store: async () => null,
         };
         this.configuration = {
             ...this.configuration,
@@ -21,20 +21,20 @@ class Database {
      * Get stored data from the database.
      */
     async onLoadDocument({ document, documentName }) {
-        const updates = await this.configuration.fetchUpdates({ documentName });
-        if (updates && updates.length) {
-            updates.forEach((update) => {
-                Y.applyUpdate(document, update);
-            });
+        const update = await this.configuration.fetch({ documentName });
+        if (update) {
+            Y.applyUpdate(document, update);
         }
         return document;
     }
     /**
      * Store new updates in the database.
      */
-    async onChange({ document, documentName }) {
-        const update = Buffer.from(Y.encodeStateAsUpdate(document));
-        return this.configuration.storeUpdate({ update, documentName });
+    async onStoreDocument(data) {
+        return this.configuration.store({
+            ...data,
+            state: Buffer.from(Y.encodeStateAsUpdate(data.document)),
+        });
     }
 }
 

package/dist/hocuspocus-database.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-database.esm.js","sources":["../src/Database.ts"],"sourcesContent":["import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetchUpdates: ({ documentName }: { documentName: string}) => Promise<Uint8Array[]>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  storeUpdate: ({ update, documentName }: { update: Buffer, documentName: string}) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetchUpdates: async () => [],\n    storeUpdate: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {\n    const updates = await this.configuration.fetchUpdates({ documentName })\n\n    if (updates && updates.length) {\n      updates.forEach((update: any) => {\n        Y.applyUpdate(document, update)\n      })\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onChange({ document, documentName }: onChangePayload) {\n    const update = Buffer.from(\n      Y.encodeStateAsUpdate(document),\n    )\n\n    return this.configuration.storeUpdate({ update, documentName })\n  }\n}\n"],"names":[],"mappings":";;MAea,QAAQ;;;;IAYnB,YAAY,aAA6C;;;;QARzD,kBAAa,GAA0B;YACrC,YAAY,EAAE,YAAY,EAAE;YAC5B,WAAW,EAAE,YAAY,IAAI;SAC9B,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB;QACpE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;QAEvE,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,OAAO,CAAC,CAAC,MAAW;gBAC1B,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;aAChC,CAAC,CAAA;SACH;QAED,OAAO,QAAQ,CAAA;KAChB;;;;IAKD,MAAM,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAmB;QACxD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CACxB,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAChC,CAAA;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;KAChE;;;;;"}
+{"version":3,"file":"hocuspocus-database.esm.js","sources":["../src/Database.ts"],"sourcesContent":["import {\n  Extension, onChangePayload, onLoadDocumentPayload, storePayload,\n} from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetch: ({ documentName }: { documentName: string}) => Promise<Uint8Array | null>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  store: (data: storePayload) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetch: async () => null,\n    store: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch({ documentName })\n\n    if (update) {\n      Y.applyUpdate(document, update)\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onStoreDocument(data: onChangePayload) {\n    return this.configuration.store({\n      ...data,\n      state: Buffer.from(\n        Y.encodeStateAsUpdate(data.document),\n      ),\n    })\n  }\n}\n"],"names":[],"mappings":";;MAiBa,QAAQ;;;;IAYnB,YAAY,aAA6C;;;;QARzD,kBAAa,GAA0B;YACrC,KAAK,EAAE,YAAY,IAAI;YACvB,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;QAE/D,IAAI,MAAM,EAAE;YACV,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;SAChC;QAED,OAAO,QAAQ,CAAA;KAChB;;;;IAKD,MAAM,eAAe,CAAC,IAAqB;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YAC9B,GAAG,IAAI;YACP,KAAK,EAAE,MAAM,CAAC,IAAI,CAChB,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;SACF,CAAC,CAAA;KACH;;;;;"}

package/dist/packages/extension-database/src/Database.d.ts

@@ -1,20 +1,16 @@
-/// <reference types="node" />
-import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onLoadDocumentPayload, storePayload } from '@hocuspocus/server';
 export interface DatabaseConfiguration {
     /**
      * Pass a Promise to retrieve updates from your database. The Promise should resolve to
      * an array of items with Y.js-compatible binary data.
      */
-    fetchUpdates: ({ documentName }: {
+    fetch: ({ documentName }: {
         documentName: string;
-    }) => Promise<Uint8Array[]>;
+    }) => Promise<Uint8Array | null>;
     /**
      * Pass a function to store updates in your database.
      */
-    storeUpdate: ({ update, documentName }: {
-        update: Buffer;
-        documentName: string;
-    }) => void;
+    store: (data: storePayload) => void;
 }
 export declare class Database implements Extension {
     /**
@@ -32,5 +28,5 @@ export declare class Database implements Extension {
     /**
      * Store new updates in the database.
      */
-    onChange({ document, documentName }: onChangePayload): Promise<void>;
+    onStoreDocument(data: onChangePayload): Promise<void>;
 }

package/dist/packages/extension-logger/src/Logger.d.ts

@@ -14,6 +14,10 @@ export interface LoggerConfiguration {
      * Whether to log something for the `onChange` hook.
      */
     onChange: boolean;
+    /**
+     * Whether to log something for the `onStoreDocument` hook.
+     */
+    onStoreDocument: boolean;
     /**
      * Whether to log something for the `onConnect` hook.
      */
@@ -53,6 +57,7 @@ export declare class Logger implements Extension {
     onConfigure(data: onConfigurePayload): Promise<void>;
     onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;
+    onStoreDocument(data: onDisconnectPayload): Promise<void>;
     onConnect(data: onConnectPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
     onUpgrade(data: onUpgradePayload): Promise<void>;

package/dist/packages/extension-sqlite/src/SQLite.d.ts

@@ -1,5 +1,8 @@
 import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database';
 import sqlite3 from 'sqlite3';
+export declare const schema = "CREATE TABLE IF NOT EXISTS \"documents\" (\n  \"name\" varchar(255) NOT NULL,\n  \"data\" blob NOT NULL,\n  UNIQUE(name)\n)";
+export declare const selectQuery = "\n  SELECT data FROM \"documents\" WHERE name = $name ORDER BY rowid DESC\n";
+export declare const upsertQuery = "\n  INSERT INTO \"documents\" (\"name\", \"data\") VALUES ($name, $data)\n    ON CONFLICT(name) DO UPDATE SET data = $data\n";
 export interface SQLiteConfiguration extends DatabaseConfiguration {
     /**
      * Valid values are filenames, ":memory:" for an anonymous in-memory database and an empty
@@ -17,10 +20,7 @@ export interface SQLiteConfiguration extends DatabaseConfiguration {
 export declare class SQLite extends Database {
     db?: sqlite3.Database;
     configuration: SQLiteConfiguration;
-    /**
-     * Constructor
-     */
     constructor(configuration?: Partial<SQLiteConfiguration>);
-    onListen(): Promise<void>;
     onConfigure(): Promise<void>;
+    onListen(): Promise<void>;
 }

package/dist/packages/extension-webhook/src/index.d.ts

@@ -3,7 +3,6 @@ import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, on
 import { Doc } from 'yjs';
 import { Transformer } from '@hocuspocus/transformer';
 import { AxiosResponse } from 'axios';
-import Timeout = NodeJS.Timeout;
 export declare enum Events {
     onChange = "change",
     onConnect = "connect",
@@ -24,7 +23,7 @@ export interface Configuration {
 export declare class Webhook implements Extension {
     configuration: Configuration;
     debounced: Map<string, {
-        timeout: Timeout;
+        timeout: NodeJS.Timeout;
         start: number;
     }>;
     /**

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

@@ -5,5 +5,5 @@ export default class EventEmitter {
     on(event: string, fn: Function): this;
     protected emit(event: string, ...args: any): this;
     off(event: string, fn?: Function): this;
-    protected removeAllListeners(): void;
+    removeAllListeners(): void;
 }

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

@@ -1,10 +1,11 @@
 import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';
 import * as mutex from 'lib0/mutex';
-import { Event, CloseEvent, MessageEvent } from 'ws';
+import type { Event, CloseEvent, MessageEvent } from 'ws';
 import EventEmitter from './EventEmitter';
 import { OutgoingMessage } from './OutgoingMessage';
 import { ConstructableOutgoingMessage } from './types';
+import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
 export declare enum WebSocketStatus {
     Connecting = "connecting",
     Connected = "connected",
@@ -99,12 +100,14 @@ export interface CompleteHocuspocusProviderConfiguration {
     onMessage: (event: MessageEvent) => void;
     onOutgoingMessage: (message: OutgoingMessage) => void;
     onStatus: (status: any) => void;
-    onSynced: () => void;
+    onSynced: ({ state }: {
+        state: boolean;
+    }) => void;
     onDisconnect: (event: CloseEvent) => void;
     onClose: (event: CloseEvent) => void;
     onDestroy: () => void;
-    onAwarenessUpdate: (states: any) => void;
-    onAwarenessChange: (states: any) => void;
+    onAwarenessUpdate: ({ states }: onAwarenessUpdateParameters) => void;
+    onAwarenessChange: ({ states }: onAwarenessChangeParameters) => void;
     /**
      * Don’t output any warnings.
      */

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

@@ -32,3 +32,13 @@ export interface Constructable<T> {
     new (...args: any): T;
 }
 export declare type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
+export declare type onAwarenessUpdateParameters = {
+    states: StatesArray;
+};
+export declare type onAwarenessChangeParameters = {
+    states: StatesArray;
+};
+export declare type StatesArray = {
+    clientId: number;
+    [key: string | number]: any;
+}[];

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

@@ -4,8 +4,8 @@ import WebSocket from 'ws';
 import { IncomingMessage as HTTPIncomingMessage } from 'http';
 import { CloseEvent } from '@hocuspocus/common';
 import Document from './Document';
-import { MessageLogger } from './Debugger';
-declare class Connection {
+import { Debugger } from './Debugger';
+export declare class Connection {
     webSocket: WebSocket;
     context: any;
     document: Document;
@@ -17,11 +17,11 @@ declare class Connection {
     socketId: string;
     lock: AsyncLock;
     readOnly: Boolean;
-    debugger: MessageLogger;
+    logger: Debugger;
     /**
      * Constructor.
      */
-    constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly?: boolean);
+    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
      */

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

@@ -1,4 +1,4 @@
-export declare class MessageLogger {
+export declare class Debugger {
     logs: any[];
     listen: boolean;
     output: boolean;
@@ -12,4 +12,3 @@ export declare class MessageLogger {
         logs: any[];
     };
 }
-export declare const Debugger: MessageLogger;

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

@@ -3,20 +3,23 @@ import { Awareness } from 'y-protocols/awareness';
 import { Doc } from 'yjs';
 import { mutex } from 'lib0/mutex.js';
 import Connection from './Connection';
-import { MessageLogger } from './Debugger';
-declare class Document extends Doc {
+import { Debugger } from './Debugger';
+export declare class Document extends Doc {
     awareness: Awareness;
     callbacks: {
         onUpdate: (document: Document, connection: Connection, update: Uint8Array) => void;
     };
-    connections: Map<any, any>;
+    connections: Map<WebSocket, {
+        clients: Set<any>;
+        connection: Connection;
+    }>;
     name: string;
     mux: mutex;
-    debugger: MessageLogger;
+    logger: Debugger;
     /**
      * Constructor.
      */
-    constructor(name: string);
+    constructor(name: string, logger: Debugger);
     /**
      * Check if the Document is empty
      */

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

@@ -1,14 +1,16 @@
 /// <reference types="node" />
-import WebSocket, { WebSocketServer } from 'ws';
+import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
 import { Configuration, Hook } from './types';
 import Document from './Document';
-import { MessageLogger } from './Debugger';
+import { Debugger } from './Debugger';
 import { onListenPayload } from '.';
 export declare const defaultConfiguration: {
     name: null;
     port: number;
     timeout: number;
+    debounce: number;
+    maxDebounce: number;
     quiet: boolean;
 };
 /**
@@ -19,7 +21,8 @@ export declare class Hocuspocus {
     documents: Map<string, Document>;
     httpServer?: HTTPServer;
     webSocketServer?: WebSocketServer;
-    debugger: MessageLogger;
+    debugger: Debugger;
+    constructor(configuration?: Partial<Configuration>);
     /**
      * Configure the server
      */
@@ -28,7 +31,11 @@ export declare class Hocuspocus {
     /**
      * Start the server
      */
-    listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any): Promise<void>;
+    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
@@ -59,32 +66,35 @@ export declare class Hocuspocus {
     handleConnection(incoming: WebSocket, request: IncomingMessage, documentName: string, context?: any): void;
     /**
      * Handle update of the given document
-     * @private
      */
     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
      */
     private createDocument;
     /**
      * Create a new connection by the given request and document
-     * @private
      */
     private createConnection;
     /**
-     * Run the given hook on all configured extensions
-     * Runs the given callback after each hook
+     * 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
      */
     private static getParameters;
     /**
      * Get document name by the given request
-     * @private
      */
     private getDocumentNameFromRequest;
     enableDebugging(): void;

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

@@ -1,10 +1,13 @@
+import { Awareness } from 'y-protocols/awareness';
 import Connection from './Connection';
 import { IncomingMessage } from './IncomingMessage';
-import { MessageLogger } from './Debugger';
+import { Debugger } from './Debugger';
+import Document from './Document';
 export declare class MessageReceiver {
     message: IncomingMessage;
-    debugger: MessageLogger;
-    constructor(message: IncomingMessage);
-    apply(connection: Connection): void;
-    readSyncMessage(message: IncomingMessage, connection: Connection): 0 | 1 | 2;
+    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

@@ -8,6 +8,7 @@ export declare class OutgoingMessage {
     constructor();
     createSyncMessage(): OutgoingMessage;
     createAwarenessUpdateMessage(awareness: Awareness, changedClients?: Array<any>): OutgoingMessage;
+    writeQueryAwareness(): OutgoingMessage;
     writeAuthenticated(): OutgoingMessage;
     writePermissionDenied(reason: string): OutgoingMessage;
     writeFirstSyncStepFor(document: Document): OutgoingMessage;

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

@@ -1,4 +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

@@ -2,13 +2,15 @@
 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
+    Auth = 2,
+    QueryAwareness = 3
 }
 /**
  * State of the WebSocket connection.
@@ -31,26 +33,31 @@ export interface ConnectionConfiguration {
     isAuthenticated: boolean;
 }
 export interface Extension {
-    onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
-    onChange?(data: onChangePayload): Promise<any>;
-    onConnect?(data: onConnectPayload): Promise<any>;
+    priority?: number;
     onConfigure?(data: onConfigurePayload): Promise<any>;
+    onListen?(data: onListenPayload): Promise<any>;
+    onUpgrade?(data: onUpgradePayload): Promise<any>;
+    onConnect?(data: onConnectPayload): Promise<any>;
+    onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
     /**
      * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
      */
     onCreateDocument?(data: onLoadDocumentPayload): Promise<any>;
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
-    onDestroy?(data: onDestroyPayload): Promise<any>;
-    onDisconnect?(data: onDisconnectPayload): Promise<any>;
-    onListen?(data: onListenPayload): 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>;
-    onUpgrade?(data: onUpgradePayload): Promise<any>;
+    onDisconnect?(data: onDisconnectPayload): Promise<any>;
+    onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type Hook = 'onAuthenticate' | 'onChange' | 'onConnect' | 'onConfigure' | 
+export declare type Hook = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'onAuthenticate' | 
 /**
  * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
  */
-'onCreateDocument' | 'onLoadDocument' | 'onDestroy' | 'onDisconnect' | 'onListen' | 'onRequest' | 'onUpgrade';
+'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
 export interface Configuration extends Extension {
     /**
      * A name for the instance, used for logging.
@@ -68,6 +75,15 @@ export interface Configuration extends Extension {
      * 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.
      */
@@ -75,11 +91,12 @@ export interface Configuration extends Extension {
     /**
      * Function which returns the (customized) document name based on the request
      */
-    getDocumentName?(data: {
-        documentName: string;
-        request: IncomingMessage;
-        requestParameters: URLSearchParams;
-    }): string | Promise<string>;
+    getDocumentName?(data: getDocumentNamePayload): string | Promise<string>;
+}
+export interface getDocumentNamePayload {
+    documentName: string;
+    request: IncomingMessage;
+    requestParameters: URLSearchParams;
 }
 export interface onAuthenticatePayload {
     documentName: string;
@@ -109,6 +126,16 @@ export interface onLoadDocumentPayload {
     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;
@@ -120,6 +147,41 @@ export interface onChangePayload {
     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;

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/provider/configuration.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 {};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/tests/transformer/TiptapTransformer.d.ts

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

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

@@ -0,0 +1 @@
+export declare const createDirectory: (dir: string) => void;

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

@@ -0,0 +1 @@
+export declare const flushRedis: () => Promise<string>;

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

@@ -0,0 +1,7 @@
+export * from './createDirectory';
+export * from './flushRedis';
+export * from './newHocuspocus';
+export * from './newHocuspocusProvider';
+export * from './redisConnectionSettings';
+export * from './removeDirectory';
+export * from './sleep';

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

@@ -0,0 +1,2 @@
+import { Hocuspocus, Configuration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<Configuration> | undefined) => Hocuspocus;

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

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

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

@@ -0,0 +1,4 @@
+export declare const redisConnectionSettings: {
+    host: string;
+    port: number;
+};

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

@@ -0,0 +1 @@
+export declare const removeDirectory: (dir: string) => void;

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

@@ -0,0 +1 @@
+export declare const sleep: (time: number) => Promise<unknown>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/extension-database",
   "description": "a generic Hocuspocus persistence driver for the database",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.6",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus",
@@ -26,11 +26,11 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^1.0.0-alpha.91",
-    "yjs": "^13.5.22"
+    "@hocuspocus/server": "^1.0.0-alpha.92",
+    "yjs": "^13.5.24"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "90e3f0955922515ccf1d643b7b43c4ad20387735"
+  "gitHead": "125d94dc3520bb5185293c9b316f66ddd9215992"
 }

package/src/Database.ts

@@ -1,4 +1,6 @@
-import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server'
+import {
+  Extension, onChangePayload, onLoadDocumentPayload, storePayload,
+} from '@hocuspocus/server'
 import * as Y from 'yjs'
 
 export interface DatabaseConfiguration {
@@ -6,11 +8,11 @@ export interface DatabaseConfiguration {
    * Pass a Promise to retrieve updates from your database. The Promise should resolve to
    * an array of items with Y.js-compatible binary data.
    */
-  fetchUpdates: ({ documentName }: { documentName: string}) => Promise<Uint8Array[]>,
+  fetch: ({ documentName }: { documentName: string}) => Promise<Uint8Array | null>,
   /**
    * Pass a function to store updates in your database.
    */
-  storeUpdate: ({ update, documentName }: { update: Buffer, documentName: string}) => void,
+  store: (data: storePayload) => void,
 }
 
 export class Database implements Extension {
@@ -18,8 +20,8 @@ export class Database implements Extension {
    * Default configuration
    */
   configuration: DatabaseConfiguration = {
-    fetchUpdates: async () => [],
-    storeUpdate: async () => null,
+    fetch: async () => null,
+    store: async () => null,
   }
 
   /**
@@ -36,12 +38,10 @@ export class Database implements Extension {
    * Get stored data from the database.
    */
   async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {
-    const updates = await this.configuration.fetchUpdates({ documentName })
+    const update = await this.configuration.fetch({ documentName })
 
-    if (updates && updates.length) {
-      updates.forEach((update: any) => {
-        Y.applyUpdate(document, update)
-      })
+    if (update) {
+      Y.applyUpdate(document, update)
     }
 
     return document
@@ -50,11 +50,12 @@ export class Database implements Extension {
   /**
    * Store new updates in the database.
    */
-  async onChange({ document, documentName }: onChangePayload) {
-    const update = Buffer.from(
-      Y.encodeStateAsUpdate(document),
-    )
-
-    return this.configuration.storeUpdate({ update, documentName })
+  async onStoreDocument(data: onChangePayload) {
+    return this.configuration.store({
+      ...data,
+      state: Buffer.from(
+        Y.encodeStateAsUpdate(data.document),
+      ),
+    })
   }
 }