@hocuspocus/extension-sqlite 1.0.0-alpha.1 → 1.0.0-alpha.5

package/dist/hocuspocus-sqlite.cjs

@@ -4,12 +4,12 @@ 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);
 
 class SQLite extends extensionDatabase.Database {
     /**
@@ -50,7 +50,7 @@ class SQLite extends extensionDatabase.Database {
         };
     }
     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.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();
     }
     async onConfigure() {

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 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(`  ${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  async onConfigure() {\n    this.db = new sqlite3.Database(this.configuration.database)\n\n    this.db.run(this.configuration.schema)\n  }\n}\n"],"names":["Database","kleur","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;;;;;"}

package/dist/hocuspocus-sqlite.esm.js

@@ -1,6 +1,6 @@
 import { Database } from '@hocuspocus/extension-database';
 import sqlite3 from 'sqlite3';
-import chalk from 'chalk';
+import kleur from 'kleur';
 
 class SQLite extends Database {
     /**
@@ -41,7 +41,7 @@ class SQLite extends Database {
         };
     }
     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.warn(`  ${kleur.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
         console.log();
     }
     async onConfigure() {

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 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(`  ${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  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;;;;;"}

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

@@ -1 +1,2 @@
 export * from './auth';
+export * from './CloseEvents';

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

@@ -10,7 +10,8 @@ export declare enum WebSocketStatus {
     Connected = "connected",
     Disconnected = "disconnected"
 }
-export interface HocuspocusProviderOptions {
+export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
+export interface CompleteHocuspocusProviderConfiguration {
     /**
      * URL of your @hocuspocus/server instance
      */
@@ -104,9 +105,13 @@ export interface HocuspocusProviderOptions {
     onDestroy: () => void;
     onAwarenessUpdate: (states: any) => void;
     onAwarenessChange: (states: any) => 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;
@@ -120,8 +125,8 @@ 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;
     connect(): Promise<void>;
     createWebSocketConnection(): Promise<unknown>;
     resolveConnectionAttempt(): void;

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

@@ -2,8 +2,8 @@
 import AsyncLock from 'async-lock';
 import WebSocket from 'ws';
 import { IncomingMessage as HTTPIncomingMessage } from 'http';
+import { CloseEvent } from '@hocuspocus/common';
 import Document from './Document';
-import { CloseEvent } from './types';
 import { MessageLogger } from './Debugger';
 declare class Connection {
     webSocket: WebSocket;

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

@@ -2,6 +2,7 @@
 import WebSocket, { WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
 import { Configuration, Hook } from './types';
+import Document from './Document';
 import { MessageLogger } from './Debugger';
 import { onListenPayload } from '.';
 export declare const defaultConfiguration: {
@@ -15,7 +16,7 @@ export declare const defaultConfiguration: {
  */
 export declare class Hocuspocus {
     configuration: Configuration;
-    documents: Map<any, any>;
+    documents: Map<string, Document>;
     httpServer?: HTTPServer;
     webSocketServer?: WebSocketServer;
     debugger: MessageLogger;
@@ -23,7 +24,7 @@ export declare class Hocuspocus {
      * Configure the server
      */
     configure(configuration: Partial<Configuration>): Hocuspocus;
-    get authenticationRequired(): boolean;
+    get requiresAuthentication(): boolean;
     /**
      * Start the server
      */
@@ -46,7 +47,14 @@ export declare class Hocuspocus {
      */
     destroy(): Promise<any>;
     /**
-     * Handle the incoming WebSocket connection
+     * The `handleConnection` method receives incoming WebSocket connections,
+     * runs all hooks:
+     *
+     *  - onConnect for all connections
+     *  - onAuthenticate only if required
+     *
+     * … and if nothings fails it’ll fully establish the connection and
+     * load the Document then.
      */
     handleConnection(incoming: WebSocket, request: IncomingMessage, documentName: string, context?: any): void;
     /**

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

@@ -1,2 +1,4 @@
 export * from './Hocuspocus';
 export * from './types';
+export * from './Document';
+export * from './Connection';

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

@@ -25,8 +25,9 @@ export interface AwarenessUpdate {
     updated: Array<any>;
     removed: Array<any>;
 }
-export interface ConnectionConfig {
+export interface ConnectionConfiguration {
     readOnly: boolean;
+    requiresAuthentication: boolean;
     isAuthenticated: boolean;
 }
 export interface Extension {
@@ -87,7 +88,7 @@ export interface onAuthenticatePayload {
     requestParameters: URLSearchParams;
     socketId: string;
     token: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     documentName: string;
@@ -96,7 +97,7 @@ export interface onConnectPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onLoadDocumentPayload {
     context: any;
@@ -106,7 +107,7 @@ export interface onLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
@@ -152,7 +153,3 @@ export interface onConfigurePayload {
     yjsVersion: string;
     instance: Hocuspocus;
 }
-export interface CloseEvent {
-    code: number;
-    reason: string;
-}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/extension-sqlite",
   "description": "a generic Hocuspocus persistence driver for the sqlite",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.5",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus",
@@ -26,8 +26,8 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/extension-database": "^1.0.0-alpha.1",
-    "chalk": "^5.0.0",
+    "@hocuspocus/extension-database": "^1.0.0-alpha.5",
+    "kleur": "^4.1.4",
     "sqlite3": "^5.0.2"
   },
   "publishConfig": {
@@ -36,5 +36,5 @@
   "devDependencies": {
     "@types/sqlite3": "^3.1.7"
   },
-  "gitHead": "8ffe8d8f4d10ba33f4f203806bd1d4415bef5dc3"
+  "gitHead": "90e3f0955922515ccf1d643b7b43c4ad20387735"
 }

package/src/SQLite.ts

@@ -1,6 +1,6 @@
 import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database'
 import sqlite3 from 'sqlite3'
-import chalk from 'chalk'
+import kleur from 'kleur'
 
 export interface SQLiteConfiguration extends DatabaseConfiguration {
   /**
@@ -60,7 +60,7 @@ export class SQLite extends Database {
   }
 
   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.warn(`  ${kleur.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`)
     console.log()
   }
 

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

@@ -1,4 +0,0 @@
-import { CloseEvent } from './types';
-export declare const Forbidden: CloseEvent;
-export declare const ResetConnection: CloseEvent;
-export declare const CloseEvents: CloseEvent[];