@hocuspocus/extension-database 1.0.0-alpha.2 → 1.0.0-alpha.21

package/README.md

@@ -5,7 +5,7 @@
 [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
 
 ## Introduction
-hocuspocus is an opinionated collaborative editing backend for [tiptap](https://github.com/ueberdosis/tiptap) – based on [Y.js](https://github.com/yjs/yjs), a CRDT framework with a powerful abstraction of shared data.
+hocuspocus is an opinionated collaborative editing backend for [Tiptap](https://github.com/ueberdosis/tiptap) – based on [Y.js](https://github.com/yjs/yjs), a CRDT framework with a powerful abstraction of shared data.
 
 ## Offical Documentation
 Documentation can be found in the [GitHub repository](https://github.com/ueberdosis/hocuspocus).

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,
@@ -44,21 +44,21 @@ 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);
-            });
+    async onLoadDocument(data) {
+        const update = await this.configuration.fetch(data);
+        if (update) {
+            Y__namespace.applyUpdate(data.document, update);
         }
-        return document;
+        return data.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,\n  onChangePayload,\n  onLoadDocumentPayload,\n  storePayload,\n  fetchPayload,\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: (data: fetchPayload) => 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(data: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch(data)\n\n    if (update) {\n      Y.applyUpdate(data.document, update)\n    }\n\n    return data.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":";;;;;;;;;;;;;;;;;;;;;;;;;;MAqBa,QAAQ,CAAA;AASnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA6C,EAAA;AAXzD;;AAEG;AACH,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,KAAK,EAAE,YAAY,IAAI;AACvB,YAAA,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;AAEG;IACH,MAAM,cAAc,CAAC,IAA2B,EAAA;QAC9C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAEnD,QAAA,IAAI,MAAM,EAAE;YACVA,YAAC,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;AACrC,SAAA;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;AAED;;AAEG;IACH,MAAM,eAAe,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;AAC9B,YAAA,GAAG,IAAI;AACP,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAChBA,YAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;AACF,SAAA,CAAC,CAAA;KACH;AACF;;;;"}

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,
@@ -20,21 +20,21 @@ 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);
-            });
+    async onLoadDocument(data) {
+        const update = await this.configuration.fetch(data);
+        if (update) {
+            Y.applyUpdate(data.document, update);
         }
-        return document;
+        return data.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,\n  onChangePayload,\n  onLoadDocumentPayload,\n  storePayload,\n  fetchPayload,\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: (data: fetchPayload) => 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(data: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch(data)\n\n    if (update) {\n      Y.applyUpdate(data.document, update)\n    }\n\n    return data.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":";;MAqBa,QAAQ,CAAA;AASnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA6C,EAAA;AAXzD;;AAEG;AACH,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,KAAK,EAAE,YAAY,IAAI;AACvB,YAAA,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;AAEG;IACH,MAAM,cAAc,CAAC,IAA2B,EAAA;QAC9C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAEnD,QAAA,IAAI,MAAM,EAAE;YACV,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;AACrC,SAAA;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;AAED;;AAEG;IACH,MAAM,eAAe,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;AAC9B,YAAA,GAAG,IAAI;AACP,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAChB,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;AACF,SAAA,CAAC,CAAA;KACH;AACF;;;;"}

package/dist/packages/common/src/CloseEvents.d.ts

@@ -0,0 +1,23 @@
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}
+/**
+ * The server successfully processed the request, asks that the requester reset
+ * its document view, and is not returning any content.
+ */
+export declare const ResetConnection: CloseEvent;
+/**
+ * Similar to Forbidden, but specifically for use when authentication is required and has
+ * failed or has not yet been provided.
+ */
+export declare const Unauthorized: CloseEvent;
+/**
+ * The request contained valid data and was understood by the server, but the server
+ * is refusing action.
+ */
+export declare const Forbidden: CloseEvent;
+/**
+ * The server timed out waiting for the request.
+ */
+export declare const ConnectionTimeout: CloseEvent;

package/dist/packages/common/src/awarenessStatesToArray.d.ts

@@ -0,0 +1,3 @@
+export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
+    clientId: number;
+}[];

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

@@ -1 +1,4 @@
 export * from './auth';
+export * from './CloseEvents';
+export * from './awarenessStatesToArray';
+export * from './types';

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

@@ -0,0 +1,10 @@
+/**
+ * State of the WebSocket connection.
+ * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
+ */
+export declare enum WsReadyStates {
+    Connecting = 0,
+    Open = 1,
+    Closing = 2,
+    Closed = 3
+}

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

@@ -1,20 +1,14 @@
-/// <reference types="node" />
-import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onLoadDocumentPayload, storePayload, fetchPayload } 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 }: {
-        documentName: string;
-    }) => Promise<Uint8Array[]>;
+    fetch: (data: fetchPayload) => 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 {
     /**
@@ -28,9 +22,9 @@ export declare class Database implements Extension {
     /**
      * Get stored data from the database.
      */
-    onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
     /**
      * 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-monitor/src/Collector.d.ts

@@ -3,7 +3,6 @@ import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPay
 export declare class Collector {
     serverConfiguration: Partial<Configuration>;
     version: string;
-    yjsVersion: string;
     connections: {};
     messages: {};
     messageCounter: number;
@@ -51,12 +50,12 @@ export declare class Collector {
     documents(): {};
     info(): Promise<{
         configuration: Partial<Configuration>;
-        ipAddress: string;
+        ipAddress: string | null;
         nodeVersion: string;
         platform: NodeJS.Platform;
         started: string;
         version: string;
-        yjsVersion: string;
     }>;
+    private getIpAddress;
     private static readableYDoc;
 }

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload, connectedPayload } from '@hocuspocus/server';
 import { IncomingMessage, ServerResponse } from 'http';
 import WebSocket from 'ws';
 import { Storage } from './Storage';
@@ -30,7 +30,7 @@ export declare class Monitor implements Extension {
     handleConnection(websocket: WebSocket, request: IncomingMessage): void | undefined;
     onRequest({ request, response }: onRequestPayload): Promise<void>;
     onUpgrade({ request, socket, head }: onUpgradePayload): Promise<void>;
-    onConnect(data: onConnectPayload): Promise<void>;
+    connected(data: connectedPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
     onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;

package/dist/packages/extension-redis/src/Redis.d.ts

@@ -1,16 +1,98 @@
-import { RedisPersistence } from 'y-redis';
-import { Extension, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import RedisClient from 'ioredis';
+import Redlock from 'redlock';
+import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, onListenPayload } from '@hocuspocus/server';
 export interface Configuration {
+    /**
+     * Redis port
+     */
+    port: number;
+    /**
+     * Redis host
+     */
+    host: string;
+    /**
+     * Options passed directly to Redis constructor
+     *
+     * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
+     */
+    options?: RedisClient.RedisOptions;
+    /**
+     * An unique instance name, required to filter messages in Redis.
+     * If none is provided an unique id is generated.
+     */
+    identifier: string;
+    /**
+     * Namespace for Redis keys, if none is provided 'hocuspocus' is used
+     */
+    prefix: string;
+    /**
+     * The maximum time for the Redis lock in ms (in case it can’t be released).
+     */
+    lockTimeout: number;
 }
 export declare class Redis implements Extension {
+    /**
+     * Make sure to give that extension a higher priority, so
+     * the `onStoreDocument` hook is able to intercept the chain,
+     * before documents are stored to the database.
+     */
+    priority: number;
     configuration: Configuration;
-    cluster: boolean;
-    persistence: RedisPersistence | undefined;
+    pub: RedisClient.Redis;
+    sub: RedisClient.Redis;
+    documents: Map<string, Document>;
+    redlock: Redlock;
+    locks: Map<string, Redlock.Lock>;
+    logger: Debugger;
+    constructor(configuration: Partial<Configuration>);
+    onConfigure({ instance }: onConfigurePayload): Promise<void>;
+    onListen({ configuration }: onListenPayload): Promise<void>;
+    private getKey;
+    private pubKey;
+    private subKey;
+    private lockKey;
+    /**
+     * Once a document is laoded, subscribe to the channel in Redis.
+     */
+    afterLoadDocument({ documentName, document }: afterLoadDocumentPayload): Promise<unknown>;
+    /**
+     * Publish the first sync step through Redis.
+     */
+    private publishFirstSyncStep;
+    /**
+     * Let’s ask Redis who is connected already.
+     */
+    private requestAwarenessFromOtherInstances;
+    /**
+     * Before the document is stored, make sure to set a lock in Redis.
+     * That’s meant to avoid conflicts with other instances trying to store the document.
+     */
+    onStoreDocument({ documentName }: onStoreDocumentPayload): Promise<unknown>;
+    /**
+     * Release the Redis lock, so other instances can store documents.
+     */
+    afterStoreDocument({ documentName }: afterStoreDocumentPayload): Promise<void>;
+    /**
+     * Handle awareness update messages received directly by this Hocuspocus instance.
+     */
+    onAwarenessUpdate({ documentName, awareness, added, updated, removed, }: onAwarenessUpdatePayload): Promise<number>;
+    /**
+     * Handle incoming messages published on all subscribed document channels.
+     * Note that this will also include messages from ourselves as it is not possible
+     * in Redis to filter these.
+    */
+    private handleIncomingMessage;
+    /**
+     * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.
+     */
+    onChange(data: onChangePayload): Promise<any>;
+    /**
+     * Make sure to *not* listen for further changes, when there’s
+     * noone connected anymore.
+     */
+    onDisconnect: ({ documentName, clientsCount }: onDisconnectPayload) => Promise<void>;
     /**
-     * Constructor
+     * Kill the Redlock connection immediately.
      */
-    constructor(configuration?: Partial<Configuration>);
-    onLoadDocument(data: onLoadDocumentPayload): Promise<import("yjs").Doc | undefined>;
-    onConnect(data: onConnectPayload): Promise<void>;
-    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onDestroy(): Promise<void>;
 }

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

@@ -1,2 +1 @@
 export * from './Redis';
-export * from './RedisCluster';

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-throttle/src/index.d.ts

@@ -1,12 +1,16 @@
 import { Extension, onConnectPayload } from '@hocuspocus/server';
-export interface Configuration {
+export interface ThrottleConfiguration {
     throttle: number | null | false;
     banTime: number;
 }
 export declare class Throttle implements Extension {
-    configuration: Configuration;
+    configuration: ThrottleConfiguration;
     connectionsByIp: Map<string, Array<number>>;
     bannedIps: Map<string, number>;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<ThrottleConfiguration>);
     /**
      * Throttle requests
      * @private

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/HocuspocusCloudProvider.d.ts

@@ -1,10 +1,11 @@
-import { HocuspocusProvider, HocuspocusProviderOptions } from './HocuspocusProvider';
-export interface HocuspocusCloudProviderOptions extends HocuspocusProviderOptions {
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
+export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & AdditionalHocuspocusCloudProviderConfiguration;
+export interface AdditionalHocuspocusCloudProviderConfiguration {
     /**
      * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
      */
     key: string;
 }
 export declare class HocuspocusCloudProvider extends HocuspocusProvider {
-    constructor(options: HocuspocusCloudProviderOptions);
+    constructor(configuration: HocuspocusCloudProviderConfiguration);
 }

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

@@ -1,16 +1,12 @@
 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';
-export declare enum WebSocketStatus {
-    Connecting = "connecting",
-    Connected = "connected",
-    Disconnected = "disconnected"
-}
-export interface HocuspocusProviderOptions {
+import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
+import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
+export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
+export interface CompleteHocuspocusProviderConfiguration {
     /**
      * URL of your @hocuspocus/server instance
      */
@@ -90,28 +86,31 @@ export interface HocuspocusProviderOptions {
      */
     timeout: number;
     onAuthenticated: () => void;
-    onAuthenticationFailed: ({ reason }: {
-        reason: string;
-    }) => void;
-    onOpen: (event: Event) => void;
+    onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
+    onOpen: (data: onOpenParameters) => void;
     onConnect: () => void;
-    onMessage: (event: MessageEvent) => void;
-    onOutgoingMessage: (message: OutgoingMessage) => void;
-    onStatus: (status: any) => void;
-    onSynced: () => void;
-    onDisconnect: (event: CloseEvent) => void;
-    onClose: (event: CloseEvent) => void;
+    onMessage: (data: onMessageParameters) => void;
+    onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
+    onStatus: (data: onStatusParameters) => void;
+    onSynced: (data: onSyncedParameters) => void;
+    onDisconnect: (data: onDisconnectParameters) => void;
+    onClose: (data: onCloseParameters) => void;
     onDestroy: () => void;
-    onAwarenessUpdate: (states: any) => void;
-    onAwarenessChange: (states: any) => void;
+    onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
+    onAwarenessChange: (data: onAwarenessChangeParameters) => void;
+    /**
+     * Don’t output any warnings.
+     */
+    quiet: boolean;
 }
 export declare class HocuspocusProvider extends EventEmitter {
-    options: HocuspocusProviderOptions;
+    configuration: CompleteHocuspocusProviderConfiguration;
     subscribedToBroadcastChannel: boolean;
     webSocket: WebSocket | null;
     shouldConnect: boolean;
     status: WebSocketStatus;
     isSynced: boolean;
+    unsyncedChanges: number;
     isAuthenticated: boolean;
     lastMessageReceived: number;
     mux: mutex.mutex;
@@ -120,16 +119,21 @@ export declare class HocuspocusProvider extends EventEmitter {
         resolve: (value?: any) => void;
         reject: (reason?: any) => void;
     } | null;
-    constructor(options?: Partial<HocuspocusProviderOptions>);
-    setOptions(options?: Partial<HocuspocusProviderOptions>): void;
+    constructor(configuration: HocuspocusProviderConfiguration);
+    setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
+    boundConnect: () => Promise<void>;
     connect(): Promise<void>;
     createWebSocketConnection(): Promise<unknown>;
     resolveConnectionAttempt(): void;
+    stopConnectionAttempt(): void;
     rejectConnectionAttempt(): void;
     get document(): Y.Doc;
     get awareness(): Awareness;
+    get hasUnsyncedChanges(): boolean;
     checkConnection(): void;
     forceSync(): void;
+    boundBeforeUnload: () => void;
+    beforeUnload(): void;
     registerEventListeners(): void;
     documentUpdateHandler(update: Uint8Array, origin: any): void;
     awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
@@ -141,15 +145,15 @@ export declare class HocuspocusProvider extends EventEmitter {
     set synced(state: boolean);
     get isAuthenticationRequired(): boolean;
     disconnect(): void;
-    onOpen(event: Event): void;
+    onOpen(event: Event): Promise<void>;
     getToken(): Promise<string | null>;
-    webSocketConnectionEstablished(): Promise<void>;
     startSync(): void;
     send(Message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
     onMessage(event: MessageEvent): void;
     onClose(event: CloseEvent): void;
     destroy(): void;
     get broadcastChannel(): string;
+    boundBroadcastChannelSubscriber: (data: ArrayBuffer) => void;
     broadcastChannelSubscriber(data: ArrayBuffer): void;
     subscribeToBroadcastChannel(): void;
     disconnectBroadcastChannel(): void;

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

@@ -1,4 +1,3 @@
 export * from './HocuspocusProvider';
 export * from './HocuspocusCloudProvider';
 export * from './types';
-export * from './utils';