@hocuspocus/extension-sqlite 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-sqlite.cjs

@@ -4,43 +4,49 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var extensionDatabase = require('@hocuspocus/extension-database');
 var sqlite3 = require('sqlite3');
-var chalk = require('chalk');
+var kleur = require('kleur');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var sqlite3__default = /*#__PURE__*/_interopDefaultLegacy(sqlite3);
-var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+var kleur__default = /*#__PURE__*/_interopDefaultLegacy(kleur);
 
+const schema = `CREATE TABLE IF NOT EXISTS "documents" (
+  "name" varchar(255) NOT NULL,
+  "data" blob NOT NULL,
+  UNIQUE(name)
+)`;
+const selectQuery = `
+  SELECT data FROM "documents" WHERE name = $name ORDER BY rowid DESC
+`;
+const upsertQuery = `
+  INSERT INTO "documents" ("name", "data") VALUES ($name, $data)
+    ON CONFLICT(name) DO UPDATE SET data = $data
+`;
 class SQLite extends extensionDatabase.Database {
-    /**
-     * Constructor
-     */
     constructor(configuration) {
         super({});
         this.configuration = {
             database: ':memory:',
-            schema: `CREATE TABLE IF NOT EXISTS "documents" (
-        "name" varchar(255) NOT NULL,
-        "data" blob NOT NULL
-    );`,
-            fetchUpdates: async ({ documentName }) => {
+            schema,
+            fetch: async ({ documentName }) => {
                 return new Promise((resolve, reject) => {
                     var _a;
-                    (_a = this.db) === null || _a === void 0 ? void 0 : _a.all('SELECT data FROM "documents" WHERE name = $name ORDER BY rowid', {
+                    (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
                         $name: documentName,
-                    }, (error, rows) => {
+                    }, (error, row) => {
                         if (error) {
                             reject(error);
                         }
-                        resolve(rows.map(row => row.data));
+                        resolve(row === null || row === void 0 ? void 0 : row.data);
                     });
                 });
             },
-            storeUpdate: async ({ documentName, update }) => {
+            store: async ({ documentName, state }) => {
                 var _a;
-                (_a = this.db) === null || _a === void 0 ? void 0 : _a.run('INSERT INTO "documents" ("name", "data") VALUES ($name, $data)', {
+                (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
                     $name: documentName,
-                    $data: update,
+                    $data: state,
                 });
             },
         };
@@ -49,15 +55,18 @@ class SQLite extends extensionDatabase.Database {
             ...configuration,
         };
     }
-    async onListen() {
-        console.warn(`  ${chalk__default["default"].yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
-        console.log();
-    }
     async onConfigure() {
         this.db = new sqlite3__default["default"].Database(this.configuration.database);
         this.db.run(this.configuration.schema);
     }
+    async onListen() {
+        console.warn(`  ${kleur__default["default"].yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
+        console.log();
+    }
 }
 
 exports.SQLite = SQLite;
+exports.schema = schema;
+exports.selectQuery = selectQuery;
+exports.upsertQuery = upsertQuery;
 //# sourceMappingURL=hocuspocus-sqlite.cjs.map

package/dist/hocuspocus-sqlite.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-sqlite.cjs","sources":["../src/SQLite.ts"],"sourcesContent":["import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database'\nimport sqlite3 from 'sqlite3'\nimport chalk from 'chalk'\n\nexport interface SQLiteConfiguration extends DatabaseConfiguration {\n  /**\n   * Valid values are filenames, \":memory:\" for an anonymous in-memory database and an empty\n   * string for an anonymous disk-based database. Anonymous databases are not persisted and\n   * when closing the database handle, their contents are lost.\n   *\n   * https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback\n   */\n  database: string,\n  /**\n   * The database schema to create.\n   */\n  schema: string,\n}\n\nexport class SQLite extends Database {\n  db?: sqlite3.Database\n\n  configuration: SQLiteConfiguration = {\n    database: ':memory:',\n    schema: `CREATE TABLE IF NOT EXISTS \"documents\" (\n        \"name\" varchar(255) NOT NULL,\n        \"data\" blob NOT NULL\n    );`,\n    fetchUpdates: async ({ documentName }) => {\n      return new Promise((resolve, reject) => {\n        this.db?.all('SELECT data FROM \"documents\" WHERE name = $name ORDER BY rowid', {\n          $name: documentName,\n        }, (error, rows) => {\n          if (error) {\n            reject(error)\n          }\n\n          resolve(rows.map(row => row.data))\n        })\n      })\n    },\n    storeUpdate: async ({ documentName, update }) => {\n      this.db?.run('INSERT INTO \"documents\" (\"name\", \"data\") VALUES ($name, $data)', {\n        $name: documentName,\n        $data: update,\n      })\n    },\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<SQLiteConfiguration>) {\n    super({})\n\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onListen() {\n    console.warn(`  ${chalk.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`)\n    console.log()\n  }\n\n  async onConfigure() {\n    this.db = new sqlite3.Database(this.configuration.database)\n\n    this.db.run(this.configuration.schema)\n  }\n}\n"],"names":["Database","chalk","sqlite3"],"mappings":";;;;;;;;;;;;;MAmBa,MAAO,SAAQA,0BAAQ;;;;IAiClC,YAAY,aAA4C;QACtD,KAAK,CAAC,EAAE,CAAC,CAAA;QA/BX,kBAAa,GAAwB;YACnC,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE;;;OAGL;YACH,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE;gBACnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM;;oBACjC,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,gEAAgE,EAAE;wBAC7E,KAAK,EAAE,YAAY;qBACpB,EAAE,CAAC,KAAK,EAAE,IAAI;wBACb,IAAI,KAAK,EAAE;4BACT,MAAM,CAAC,KAAK,CAAC,CAAA;yBACd;wBAED,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;qBACnC,CAAC,CAAA;iBACH,CAAC,CAAA;aACH;YACD,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE;;gBAC1C,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,gEAAgE,EAAE;oBAC7E,KAAK,EAAE,YAAY;oBACnB,KAAK,EAAE,MAAM;iBACd,CAAC,CAAA;aACH;SACF,CAAA;QAQC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,QAAQ;QACZ,OAAO,CAAC,IAAI,CAAC,KAAKC,yBAAK,CAAC,MAAM,CAAC,kHAAkH,CAAC,EAAE,CAAC,CAAA;QACrJ,OAAO,CAAC,GAAG,EAAE,CAAA;KACd;IAED,MAAM,WAAW;QACf,IAAI,CAAC,EAAE,GAAG,IAAIC,2BAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;QAE3D,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;KACvC;;;;;"}
+{"version":3,"file":"hocuspocus-sqlite.cjs","sources":["../src/SQLite.ts"],"sourcesContent":["import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database'\nimport sqlite3 from 'sqlite3'\nimport kleur from 'kleur'\n\nexport const schema = `CREATE TABLE IF NOT EXISTS \"documents\" (\n  \"name\" varchar(255) NOT NULL,\n  \"data\" blob NOT NULL,\n  UNIQUE(name)\n)`\n\nexport const selectQuery = `\n  SELECT data FROM \"documents\" WHERE name = $name ORDER BY rowid DESC\n`\n\nexport const upsertQuery = `\n  INSERT INTO \"documents\" (\"name\", \"data\") VALUES ($name, $data)\n    ON CONFLICT(name) DO UPDATE SET data = $data\n`\n\nexport interface SQLiteConfiguration extends DatabaseConfiguration {\n  /**\n   * Valid values are filenames, \":memory:\" for an anonymous in-memory database and an empty\n   * string for an anonymous disk-based database. Anonymous databases are not persisted and\n   * when closing the database handle, their contents are lost.\n   *\n   * https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback\n   */\n  database: string,\n  /**\n   * The database schema to create.\n   */\n  schema: string,\n}\n\nexport class SQLite extends Database {\n  db?: sqlite3.Database\n\n  configuration: SQLiteConfiguration = {\n    database: ':memory:',\n    schema,\n    fetch: async ({ documentName }) => {\n      return new Promise((resolve, reject) => {\n        this.db?.get(selectQuery, {\n          $name: documentName,\n        }, (error, row) => {\n          if (error) {\n            reject(error)\n          }\n\n          resolve(row?.data)\n        })\n      })\n    },\n    store: async ({ documentName, state }) => {\n      this.db?.run(upsertQuery, {\n        $name: documentName,\n        $data: state,\n      })\n    },\n  }\n\n  constructor(configuration?: Partial<SQLiteConfiguration>) {\n    super({})\n\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onConfigure() {\n    this.db = new sqlite3.Database(this.configuration.database)\n    this.db.run(this.configuration.schema)\n  }\n\n  async onListen() {\n    console.warn(`  ${kleur.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`)\n    console.log()\n  }\n}\n"],"names":["Database","sqlite3","kleur"],"mappings":";;;;;;;;;;;;;AAIa,MAAA,MAAM,GAAG,CAAA;;;;GAIpB;AAEW,MAAA,WAAW,GAAG,CAAA;;EAE1B;AAEY,MAAA,WAAW,GAAG,CAAA;;;EAG1B;AAiBK,MAAO,MAAO,SAAQA,0BAAQ,CAAA;AA2BlC,IAAA,WAAA,CAAY,aAA4C,EAAA;QACtD,KAAK,CAAC,EAAE,CAAC,CAAA;AAzBX,QAAA,IAAA,CAAA,aAAa,GAAwB;AACnC,YAAA,QAAQ,EAAE,UAAU;YACpB,MAAM;AACN,YAAA,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAI;gBAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;;AACrC,oBAAA,CAAA,EAAA,GAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;AACxB,wBAAA,KAAK,EAAE,YAAY;AACpB,qBAAA,EAAE,CAAC,KAAK,EAAE,GAAG,KAAI;AAChB,wBAAA,IAAI,KAAK,EAAE;4BACT,MAAM,CAAC,KAAK,CAAC,CAAA;AACd,yBAAA;wBAED,OAAO,CAAC,GAAG,KAAH,IAAA,IAAA,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC,CAAA;AACpB,qBAAC,CAAC,CAAA;AACJ,iBAAC,CAAC,CAAA;aACH;YACD,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,KAAI;;AACvC,gBAAA,CAAA,EAAA,GAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;AACxB,oBAAA,KAAK,EAAE,YAAY;AACnB,oBAAA,KAAK,EAAE,KAAK;AACb,iBAAA,CAAC,CAAA;aACH;SACF,CAAA;QAKC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED,IAAA,MAAM,WAAW,GAAA;AACf,QAAA,IAAI,CAAC,EAAE,GAAG,IAAIC,2BAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;QAC3D,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;KACvC;AAED,IAAA,MAAM,QAAQ,GAAA;AACZ,QAAA,OAAO,CAAC,IAAI,CAAC,CAAA,EAAA,EAAKC,yBAAK,CAAC,MAAM,CAAC,kHAAkH,CAAC,CAAE,CAAA,CAAC,CAAA;QACrJ,OAAO,CAAC,GAAG,EAAE,CAAA;KACd;AACF;;;;;;;"}

package/dist/hocuspocus-sqlite.esm.js

@@ -1,37 +1,43 @@
 import { Database } from '@hocuspocus/extension-database';
 import sqlite3 from 'sqlite3';
-import chalk from 'chalk';
+import kleur from 'kleur';
 
+const schema = `CREATE TABLE IF NOT EXISTS "documents" (
+  "name" varchar(255) NOT NULL,
+  "data" blob NOT NULL,
+  UNIQUE(name)
+)`;
+const selectQuery = `
+  SELECT data FROM "documents" WHERE name = $name ORDER BY rowid DESC
+`;
+const upsertQuery = `
+  INSERT INTO "documents" ("name", "data") VALUES ($name, $data)
+    ON CONFLICT(name) DO UPDATE SET data = $data
+`;
 class SQLite extends Database {
-    /**
-     * Constructor
-     */
     constructor(configuration) {
         super({});
         this.configuration = {
             database: ':memory:',
-            schema: `CREATE TABLE IF NOT EXISTS "documents" (
-        "name" varchar(255) NOT NULL,
-        "data" blob NOT NULL
-    );`,
-            fetchUpdates: async ({ documentName }) => {
+            schema,
+            fetch: async ({ documentName }) => {
                 return new Promise((resolve, reject) => {
                     var _a;
-                    (_a = this.db) === null || _a === void 0 ? void 0 : _a.all('SELECT data FROM "documents" WHERE name = $name ORDER BY rowid', {
+                    (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
                         $name: documentName,
-                    }, (error, rows) => {
+                    }, (error, row) => {
                         if (error) {
                             reject(error);
                         }
-                        resolve(rows.map(row => row.data));
+                        resolve(row === null || row === void 0 ? void 0 : row.data);
                     });
                 });
             },
-            storeUpdate: async ({ documentName, update }) => {
+            store: async ({ documentName, state }) => {
                 var _a;
-                (_a = this.db) === null || _a === void 0 ? void 0 : _a.run('INSERT INTO "documents" ("name", "data") VALUES ($name, $data)', {
+                (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
                     $name: documentName,
-                    $data: update,
+                    $data: state,
                 });
             },
         };
@@ -40,15 +46,15 @@ class SQLite extends Database {
             ...configuration,
         };
     }
-    async onListen() {
-        console.warn(`  ${chalk.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
-        console.log();
-    }
     async onConfigure() {
         this.db = new sqlite3.Database(this.configuration.database);
         this.db.run(this.configuration.schema);
     }
+    async onListen() {
+        console.warn(`  ${kleur.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
+        console.log();
+    }
 }
 
-export { SQLite };
+export { SQLite, schema, selectQuery, upsertQuery };
 //# sourceMappingURL=hocuspocus-sqlite.esm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-sqlite.esm.js","sources":["../src/SQLite.ts"],"sourcesContent":["import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database'\nimport sqlite3 from 'sqlite3'\nimport chalk from 'chalk'\n\nexport interface SQLiteConfiguration extends DatabaseConfiguration {\n  /**\n   * Valid values are filenames, \":memory:\" for an anonymous in-memory database and an empty\n   * string for an anonymous disk-based database. Anonymous databases are not persisted and\n   * when closing the database handle, their contents are lost.\n   *\n   * https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback\n   */\n  database: string,\n  /**\n   * The database schema to create.\n   */\n  schema: string,\n}\n\nexport class SQLite extends Database {\n  db?: sqlite3.Database\n\n  configuration: SQLiteConfiguration = {\n    database: ':memory:',\n    schema: `CREATE TABLE IF NOT EXISTS \"documents\" (\n        \"name\" varchar(255) NOT NULL,\n        \"data\" blob NOT NULL\n    );`,\n    fetchUpdates: async ({ documentName }) => {\n      return new Promise((resolve, reject) => {\n        this.db?.all('SELECT data FROM \"documents\" WHERE name = $name ORDER BY rowid', {\n          $name: documentName,\n        }, (error, rows) => {\n          if (error) {\n            reject(error)\n          }\n\n          resolve(rows.map(row => row.data))\n        })\n      })\n    },\n    storeUpdate: async ({ documentName, update }) => {\n      this.db?.run('INSERT INTO \"documents\" (\"name\", \"data\") VALUES ($name, $data)', {\n        $name: documentName,\n        $data: update,\n      })\n    },\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<SQLiteConfiguration>) {\n    super({})\n\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onListen() {\n    console.warn(`  ${chalk.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`)\n    console.log()\n  }\n\n  async onConfigure() {\n    this.db = new sqlite3.Database(this.configuration.database)\n\n    this.db.run(this.configuration.schema)\n  }\n}\n"],"names":[],"mappings":";;;;MAmBa,MAAO,SAAQ,QAAQ;;;;IAiClC,YAAY,aAA4C;QACtD,KAAK,CAAC,EAAE,CAAC,CAAA;QA/BX,kBAAa,GAAwB;YACnC,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE;;;OAGL;YACH,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE;gBACnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM;;oBACjC,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,gEAAgE,EAAE;wBAC7E,KAAK,EAAE,YAAY;qBACpB,EAAE,CAAC,KAAK,EAAE,IAAI;wBACb,IAAI,KAAK,EAAE;4BACT,MAAM,CAAC,KAAK,CAAC,CAAA;yBACd;wBAED,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;qBACnC,CAAC,CAAA;iBACH,CAAC,CAAA;aACH;YACD,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE;;gBAC1C,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,gEAAgE,EAAE;oBAC7E,KAAK,EAAE,YAAY;oBACnB,KAAK,EAAE,MAAM;iBACd,CAAC,CAAA;aACH;SACF,CAAA;QAQC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,QAAQ;QACZ,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,kHAAkH,CAAC,EAAE,CAAC,CAAA;QACrJ,OAAO,CAAC,GAAG,EAAE,CAAA;KACd;IAED,MAAM,WAAW;QACf,IAAI,CAAC,EAAE,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;QAE3D,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;KACvC;;;;;"}
+{"version":3,"file":"hocuspocus-sqlite.esm.js","sources":["../src/SQLite.ts"],"sourcesContent":["import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database'\nimport sqlite3 from 'sqlite3'\nimport kleur from 'kleur'\n\nexport const schema = `CREATE TABLE IF NOT EXISTS \"documents\" (\n  \"name\" varchar(255) NOT NULL,\n  \"data\" blob NOT NULL,\n  UNIQUE(name)\n)`\n\nexport const selectQuery = `\n  SELECT data FROM \"documents\" WHERE name = $name ORDER BY rowid DESC\n`\n\nexport const upsertQuery = `\n  INSERT INTO \"documents\" (\"name\", \"data\") VALUES ($name, $data)\n    ON CONFLICT(name) DO UPDATE SET data = $data\n`\n\nexport interface SQLiteConfiguration extends DatabaseConfiguration {\n  /**\n   * Valid values are filenames, \":memory:\" for an anonymous in-memory database and an empty\n   * string for an anonymous disk-based database. Anonymous databases are not persisted and\n   * when closing the database handle, their contents are lost.\n   *\n   * https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback\n   */\n  database: string,\n  /**\n   * The database schema to create.\n   */\n  schema: string,\n}\n\nexport class SQLite extends Database {\n  db?: sqlite3.Database\n\n  configuration: SQLiteConfiguration = {\n    database: ':memory:',\n    schema,\n    fetch: async ({ documentName }) => {\n      return new Promise((resolve, reject) => {\n        this.db?.get(selectQuery, {\n          $name: documentName,\n        }, (error, row) => {\n          if (error) {\n            reject(error)\n          }\n\n          resolve(row?.data)\n        })\n      })\n    },\n    store: async ({ documentName, state }) => {\n      this.db?.run(upsertQuery, {\n        $name: documentName,\n        $data: state,\n      })\n    },\n  }\n\n  constructor(configuration?: Partial<SQLiteConfiguration>) {\n    super({})\n\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onConfigure() {\n    this.db = new sqlite3.Database(this.configuration.database)\n    this.db.run(this.configuration.schema)\n  }\n\n  async onListen() {\n    console.warn(`  ${kleur.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`)\n    console.log()\n  }\n}\n"],"names":[],"mappings":";;;;AAIa,MAAA,MAAM,GAAG,CAAA;;;;GAIpB;AAEW,MAAA,WAAW,GAAG,CAAA;;EAE1B;AAEY,MAAA,WAAW,GAAG,CAAA;;;EAG1B;AAiBK,MAAO,MAAO,SAAQ,QAAQ,CAAA;AA2BlC,IAAA,WAAA,CAAY,aAA4C,EAAA;QACtD,KAAK,CAAC,EAAE,CAAC,CAAA;AAzBX,QAAA,IAAA,CAAA,aAAa,GAAwB;AACnC,YAAA,QAAQ,EAAE,UAAU;YACpB,MAAM;AACN,YAAA,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAI;gBAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;;AACrC,oBAAA,CAAA,EAAA,GAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;AACxB,wBAAA,KAAK,EAAE,YAAY;AACpB,qBAAA,EAAE,CAAC,KAAK,EAAE,GAAG,KAAI;AAChB,wBAAA,IAAI,KAAK,EAAE;4BACT,MAAM,CAAC,KAAK,CAAC,CAAA;AACd,yBAAA;wBAED,OAAO,CAAC,GAAG,KAAH,IAAA,IAAA,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC,CAAA;AACpB,qBAAC,CAAC,CAAA;AACJ,iBAAC,CAAC,CAAA;aACH;YACD,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,KAAI;;AACvC,gBAAA,CAAA,EAAA,GAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;AACxB,oBAAA,KAAK,EAAE,YAAY;AACnB,oBAAA,KAAK,EAAE,KAAK;AACb,iBAAA,CAAC,CAAA;aACH;SACF,CAAA;QAKC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED,IAAA,MAAM,WAAW,GAAA;AACf,QAAA,IAAI,CAAC,EAAE,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;QAC3D,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;KACvC;AAED,IAAA,MAAM,QAAQ,GAAA;AACZ,QAAA,OAAO,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,KAAK,CAAC,MAAM,CAAC,kHAAkH,CAAC,CAAE,CAAA,CAAC,CAAA;QACrJ,OAAO,CAAC,GAAG,EAAE,CAAA;KACd;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);
 }