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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/dist/hocuspocus-sqlite.cjs +29 -20
  2. package/dist/hocuspocus-sqlite.cjs.map +1 -1
  3. package/dist/hocuspocus-sqlite.esm.js +26 -20
  4. package/dist/hocuspocus-sqlite.esm.js.map +1 -1
  5. package/dist/packages/common/src/CloseEvents.d.ts +23 -0
  6. package/dist/packages/common/src/awarenessStatesToArray.d.ts +3 -0
  7. package/dist/packages/common/src/index.d.ts +3 -0
  8. package/dist/packages/common/src/types.d.ts +10 -0
  9. package/dist/packages/extension-database/src/Database.d.ts +5 -9
  10. package/dist/packages/extension-logger/src/Logger.d.ts +5 -0
  11. package/dist/packages/extension-monitor/src/Collector.d.ts +0 -2
  12. package/dist/packages/extension-monitor/src/index.d.ts +2 -2
  13. package/dist/packages/extension-sqlite/src/SQLite.d.ts +4 -4
  14. package/dist/packages/extension-throttle/src/index.d.ts +6 -2
  15. package/dist/packages/extension-webhook/src/index.d.ts +1 -2
  16. package/dist/packages/provider/src/EventEmitter.d.ts +1 -1
  17. package/dist/packages/provider/src/HocuspocusCloudProvider.d.ts +4 -3
  18. package/dist/packages/provider/src/HocuspocusProvider.d.ts +24 -26
  19. package/dist/packages/provider/src/index.d.ts +0 -1
  20. package/dist/packages/provider/src/types.d.ts +43 -0
  21. package/dist/packages/server/src/Connection.d.ts +5 -5
  22. package/dist/packages/server/src/Debugger.d.ts +1 -2
  23. package/dist/packages/server/src/Document.d.ts +8 -5
  24. package/dist/packages/server/src/Hocuspocus.d.ts +32 -14
  25. package/dist/packages/server/src/MessageReceiver.d.ts +8 -5
  26. package/dist/packages/server/src/OutgoingMessage.d.ts +1 -0
  27. package/dist/packages/server/src/index.d.ts +7 -0
  28. package/dist/packages/server/src/types.d.ts +92 -34
  29. package/dist/tests/extension-logger/onListen.d.ts +1 -0
  30. package/dist/tests/extension-redis/onLoadDocument.d.ts +1 -0
  31. package/dist/tests/extension-redis/onSynced.d.ts +1 -0
  32. package/dist/tests/extension-redis-rewrite/closeConnections.d.ts +1 -0
  33. package/dist/tests/extension-redis-rewrite/getConnectionCount.d.ts +1 -0
  34. package/dist/tests/extension-redis-rewrite/getDocumentsCount.d.ts +1 -0
  35. package/dist/tests/extension-redis-rewrite/onAwarenessChange.d.ts +1 -0
  36. package/dist/tests/extension-redis-rewrite/onChange.d.ts +1 -0
  37. package/dist/tests/extension-redis-rewrite/onStoreDocument.d.ts +1 -0
  38. package/dist/tests/extension-rocksdb/onLoadDocument.d.ts +1 -0
  39. package/dist/tests/extension-throttle/configuration.d.ts +1 -0
  40. package/dist/tests/provider/configuration.d.ts +1 -0
  41. package/dist/tests/provider/observe.d.ts +1 -0
  42. package/dist/tests/provider/observeDeep.d.ts +1 -0
  43. package/dist/tests/provider/onAuthenticated.d.ts +1 -0
  44. package/dist/tests/provider/onAuthenticationFailed.d.ts +1 -0
  45. package/dist/tests/provider/onAwarenessChange.d.ts +1 -0
  46. package/dist/tests/provider/onAwarenessUpdate.d.ts +1 -0
  47. package/dist/tests/provider/onClose.d.ts +1 -0
  48. package/dist/tests/provider/onConnect.d.ts +1 -0
  49. package/dist/tests/provider/onDisconnect.d.ts +1 -0
  50. package/dist/tests/provider/onMessage.d.ts +1 -0
  51. package/dist/tests/provider/onOpen.d.ts +1 -0
  52. package/dist/tests/provider/onSynced.d.ts +1 -0
  53. package/dist/tests/server/address.d.ts +1 -0
  54. package/dist/tests/server/afterStoreDocument.d.ts +1 -0
  55. package/dist/tests/server/closeConnections.d.ts +1 -0
  56. package/dist/tests/server/getConnectionsCount.d.ts +1 -0
  57. package/dist/tests/server/getDocumentName.d.ts +1 -0
  58. package/dist/tests/server/getDocumentsCount.d.ts +1 -0
  59. package/dist/tests/server/getMessageLogs.d.ts +1 -0
  60. package/dist/tests/server/listen.d.ts +1 -0
  61. package/dist/tests/server/onAuthenticate.d.ts +1 -0
  62. package/dist/tests/server/onAwarenessUpdate.d.ts +1 -0
  63. package/dist/tests/server/onChange.d.ts +1 -0
  64. package/dist/tests/server/onConfigure.d.ts +1 -0
  65. package/dist/tests/server/onConnect.d.ts +1 -0
  66. package/dist/tests/server/onDestroy.d.ts +1 -0
  67. package/dist/tests/server/onDisconnect.d.ts +1 -0
  68. package/dist/tests/server/onListen.d.ts +1 -0
  69. package/dist/tests/server/onLoadDocument.d.ts +1 -0
  70. package/dist/tests/server/onRequest.d.ts +1 -0
  71. package/dist/tests/server/onStoreDocument.d.ts +1 -0
  72. package/dist/tests/server/onUpgrade.d.ts +1 -0
  73. package/dist/tests/server/requiresAuthentication.d.ts +1 -0
  74. package/dist/tests/transformer/TiptapTransformer.d.ts +1 -0
  75. package/dist/tests/utils/createDirectory.d.ts +1 -0
  76. package/dist/tests/utils/flushRedis.d.ts +1 -0
  77. package/dist/tests/utils/index.d.ts +7 -0
  78. package/dist/tests/utils/newHocuspocus.d.ts +2 -0
  79. package/dist/tests/utils/newHocuspocusProvider.d.ts +3 -0
  80. package/dist/tests/utils/redisConnectionSettings.d.ts +4 -0
  81. package/dist/tests/utils/removeDirectory.d.ts +1 -0
  82. package/dist/tests/utils/sleep.d.ts +1 -0
  83. package/package.json +5 -5
  84. package/src/SQLite.ts +29 -21
  85. package/dist/packages/provider/src/utils/awarenessStatesToArray.d.ts +0 -4
  86. package/dist/packages/provider/src/utils/index.d.ts +0 -1
  87. package/dist/packages/server/src/CloseEvents.d.ts +0 -4
@@ -4,43 +4,49 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var extensionDatabase = require('@hocuspocus/extension-database');
6
6
  var sqlite3 = require('sqlite3');
7
- var chalk = require('chalk');
7
+ var kleur = require('kleur');
8
8
 
9
9
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
10
10
 
11
11
  var sqlite3__default = /*#__PURE__*/_interopDefaultLegacy(sqlite3);
12
- var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
12
+ var kleur__default = /*#__PURE__*/_interopDefaultLegacy(kleur);
13
13
 
14
+ const schema = `CREATE TABLE IF NOT EXISTS "documents" (
15
+ "name" varchar(255) NOT NULL,
16
+ "data" blob NOT NULL,
17
+ UNIQUE(name)
18
+ )`;
19
+ const selectQuery = `
20
+ SELECT data FROM "documents" WHERE name = $name ORDER BY rowid DESC
21
+ `;
22
+ const upsertQuery = `
23
+ INSERT INTO "documents" ("name", "data") VALUES ($name, $data)
24
+ ON CONFLICT(name) DO UPDATE SET data = $data
25
+ `;
14
26
  class SQLite extends extensionDatabase.Database {
15
- /**
16
- * Constructor
17
- */
18
27
  constructor(configuration) {
19
28
  super({});
20
29
  this.configuration = {
21
30
  database: ':memory:',
22
- schema: `CREATE TABLE IF NOT EXISTS "documents" (
23
- "name" varchar(255) NOT NULL,
24
- "data" blob NOT NULL
25
- );`,
26
- fetchUpdates: async ({ documentName }) => {
31
+ schema,
32
+ fetch: async ({ documentName }) => {
27
33
  return new Promise((resolve, reject) => {
28
34
  var _a;
29
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.all('SELECT data FROM "documents" WHERE name = $name ORDER BY rowid', {
35
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
30
36
  $name: documentName,
31
- }, (error, rows) => {
37
+ }, (error, row) => {
32
38
  if (error) {
33
39
  reject(error);
34
40
  }
35
- resolve(rows.map(row => row.data));
41
+ resolve(row === null || row === void 0 ? void 0 : row.data);
36
42
  });
37
43
  });
38
44
  },
39
- storeUpdate: async ({ documentName, update }) => {
45
+ store: async ({ documentName, state }) => {
40
46
  var _a;
41
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.run('INSERT INTO "documents" ("name", "data") VALUES ($name, $data)', {
47
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
42
48
  $name: documentName,
43
- $data: update,
49
+ $data: state,
44
50
  });
45
51
  },
46
52
  };
@@ -49,15 +55,18 @@ class SQLite extends extensionDatabase.Database {
49
55
  ...configuration,
50
56
  };
51
57
  }
52
- async onListen() {
53
- console.warn(` ${chalk__default["default"].yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
54
- console.log();
55
- }
56
58
  async onConfigure() {
57
59
  this.db = new sqlite3__default["default"].Database(this.configuration.database);
58
60
  this.db.run(this.configuration.schema);
59
61
  }
62
+ async onListen() {
63
+ console.warn(` ${kleur__default["default"].yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
64
+ console.log();
65
+ }
60
66
  }
61
67
 
62
68
  exports.SQLite = SQLite;
69
+ exports.schema = schema;
70
+ exports.selectQuery = selectQuery;
71
+ exports.upsertQuery = upsertQuery;
63
72
  //# sourceMappingURL=hocuspocus-sqlite.cjs.map
@@ -1 +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;;;;;"}
1
+ {"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;;;;;;;"}
@@ -1,37 +1,43 @@
1
1
  import { Database } from '@hocuspocus/extension-database';
2
2
  import sqlite3 from 'sqlite3';
3
- import chalk from 'chalk';
3
+ import kleur from 'kleur';
4
4
 
5
+ const schema = `CREATE TABLE IF NOT EXISTS "documents" (
6
+ "name" varchar(255) NOT NULL,
7
+ "data" blob NOT NULL,
8
+ UNIQUE(name)
9
+ )`;
10
+ const selectQuery = `
11
+ SELECT data FROM "documents" WHERE name = $name ORDER BY rowid DESC
12
+ `;
13
+ const upsertQuery = `
14
+ INSERT INTO "documents" ("name", "data") VALUES ($name, $data)
15
+ ON CONFLICT(name) DO UPDATE SET data = $data
16
+ `;
5
17
  class SQLite extends Database {
6
- /**
7
- * Constructor
8
- */
9
18
  constructor(configuration) {
10
19
  super({});
11
20
  this.configuration = {
12
21
  database: ':memory:',
13
- schema: `CREATE TABLE IF NOT EXISTS "documents" (
14
- "name" varchar(255) NOT NULL,
15
- "data" blob NOT NULL
16
- );`,
17
- fetchUpdates: async ({ documentName }) => {
22
+ schema,
23
+ fetch: async ({ documentName }) => {
18
24
  return new Promise((resolve, reject) => {
19
25
  var _a;
20
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.all('SELECT data FROM "documents" WHERE name = $name ORDER BY rowid', {
26
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
21
27
  $name: documentName,
22
- }, (error, rows) => {
28
+ }, (error, row) => {
23
29
  if (error) {
24
30
  reject(error);
25
31
  }
26
- resolve(rows.map(row => row.data));
32
+ resolve(row === null || row === void 0 ? void 0 : row.data);
27
33
  });
28
34
  });
29
35
  },
30
- storeUpdate: async ({ documentName, update }) => {
36
+ store: async ({ documentName, state }) => {
31
37
  var _a;
32
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.run('INSERT INTO "documents" ("name", "data") VALUES ($name, $data)', {
38
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
33
39
  $name: documentName,
34
- $data: update,
40
+ $data: state,
35
41
  });
36
42
  },
37
43
  };
@@ -40,15 +46,15 @@ class SQLite extends Database {
40
46
  ...configuration,
41
47
  };
42
48
  }
43
- async onListen() {
44
- console.warn(` ${chalk.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
45
- console.log();
46
- }
47
49
  async onConfigure() {
48
50
  this.db = new sqlite3.Database(this.configuration.database);
49
51
  this.db.run(this.configuration.schema);
50
52
  }
53
+ async onListen() {
54
+ console.warn(` ${kleur.yellow('The SQLite extension is intended to be used in a local development environment, not in a production environment.')}`);
55
+ console.log();
56
+ }
51
57
  }
52
58
 
53
- export { SQLite };
59
+ export { SQLite, schema, selectQuery, upsertQuery };
54
60
  //# sourceMappingURL=hocuspocus-sqlite.esm.js.map
@@ -1 +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;;;;;"}
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 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;;;;"}
@@ -0,0 +1,23 @@
1
+ export interface CloseEvent {
2
+ code: number;
3
+ reason: string;
4
+ }
5
+ /**
6
+ * The server successfully processed the request, asks that the requester reset
7
+ * its document view, and is not returning any content.
8
+ */
9
+ export declare const ResetConnection: CloseEvent;
10
+ /**
11
+ * Similar to Forbidden, but specifically for use when authentication is required and has
12
+ * failed or has not yet been provided.
13
+ */
14
+ export declare const Unauthorized: CloseEvent;
15
+ /**
16
+ * The request contained valid data and was understood by the server, but the server
17
+ * is refusing action.
18
+ */
19
+ export declare const Forbidden: CloseEvent;
20
+ /**
21
+ * The server timed out waiting for the request.
22
+ */
23
+ export declare const ConnectionTimeout: CloseEvent;
@@ -0,0 +1,3 @@
1
+ export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
2
+ clientId: number;
3
+ }[];
@@ -1 +1,4 @@
1
1
  export * from './auth';
2
+ export * from './CloseEvents';
3
+ export * from './awarenessStatesToArray';
4
+ export * from './types';
@@ -0,0 +1,10 @@
1
+ /**
2
+ * State of the WebSocket connection.
3
+ * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
4
+ */
5
+ export declare enum WsReadyStates {
6
+ Connecting = 0,
7
+ Open = 1,
8
+ Closing = 2,
9
+ Closed = 3
10
+ }
@@ -1,20 +1,16 @@
1
- /// <reference types="node" />
2
- import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server';
1
+ import { Extension, onChangePayload, onLoadDocumentPayload, storePayload } from '@hocuspocus/server';
3
2
  export interface DatabaseConfiguration {
4
3
  /**
5
4
  * Pass a Promise to retrieve updates from your database. The Promise should resolve to
6
5
  * an array of items with Y.js-compatible binary data.
7
6
  */
8
- fetchUpdates: ({ documentName }: {
7
+ fetch: ({ documentName }: {
9
8
  documentName: string;
10
- }) => Promise<Uint8Array[]>;
9
+ }) => Promise<Uint8Array | null>;
11
10
  /**
12
11
  * Pass a function to store updates in your database.
13
12
  */
14
- storeUpdate: ({ update, documentName }: {
15
- update: Buffer;
16
- documentName: string;
17
- }) => void;
13
+ store: (data: storePayload) => void;
18
14
  }
19
15
  export declare class Database implements Extension {
20
16
  /**
@@ -32,5 +28,5 @@ export declare class Database implements Extension {
32
28
  /**
33
29
  * Store new updates in the database.
34
30
  */
35
- onChange({ document, documentName }: onChangePayload): Promise<void>;
31
+ onStoreDocument(data: onChangePayload): Promise<void>;
36
32
  }
@@ -14,6 +14,10 @@ export interface LoggerConfiguration {
14
14
  * Whether to log something for the `onChange` hook.
15
15
  */
16
16
  onChange: boolean;
17
+ /**
18
+ * Whether to log something for the `onStoreDocument` hook.
19
+ */
20
+ onStoreDocument: boolean;
17
21
  /**
18
22
  * Whether to log something for the `onConnect` hook.
19
23
  */
@@ -53,6 +57,7 @@ export declare class Logger implements Extension {
53
57
  onConfigure(data: onConfigurePayload): Promise<void>;
54
58
  onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
55
59
  onChange(data: onChangePayload): Promise<void>;
60
+ onStoreDocument(data: onDisconnectPayload): Promise<void>;
56
61
  onConnect(data: onConnectPayload): Promise<void>;
57
62
  onDisconnect(data: onDisconnectPayload): Promise<void>;
58
63
  onUpgrade(data: onUpgradePayload): Promise<void>;
@@ -3,7 +3,6 @@ import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPay
3
3
  export declare class Collector {
4
4
  serverConfiguration: Partial<Configuration>;
5
5
  version: string;
6
- yjsVersion: string;
7
6
  connections: {};
8
7
  messages: {};
9
8
  messageCounter: number;
@@ -56,7 +55,6 @@ export declare class Collector {
56
55
  platform: NodeJS.Platform;
57
56
  started: string;
58
57
  version: string;
59
- yjsVersion: string;
60
58
  }>;
61
59
  private static readableYDoc;
62
60
  }
@@ -1,5 +1,5 @@
1
1
  /// <reference types="node" />
2
- import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
2
+ import { Extension, onChangePayload, onConfigurePayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload, connectedPayload } from '@hocuspocus/server';
3
3
  import { IncomingMessage, ServerResponse } from 'http';
4
4
  import WebSocket from 'ws';
5
5
  import { Storage } from './Storage';
@@ -30,7 +30,7 @@ export declare class Monitor implements Extension {
30
30
  handleConnection(websocket: WebSocket, request: IncomingMessage): void | undefined;
31
31
  onRequest({ request, response }: onRequestPayload): Promise<void>;
32
32
  onUpgrade({ request, socket, head }: onUpgradePayload): Promise<void>;
33
- onConnect(data: onConnectPayload): Promise<void>;
33
+ connected(data: connectedPayload): Promise<void>;
34
34
  onDisconnect(data: onDisconnectPayload): Promise<void>;
35
35
  onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
36
36
  onChange(data: onChangePayload): Promise<void>;
@@ -1,5 +1,8 @@
1
1
  import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database';
2
2
  import sqlite3 from 'sqlite3';
3
+ 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)";
4
+ export declare const selectQuery = "\n SELECT data FROM \"documents\" WHERE name = $name ORDER BY rowid DESC\n";
5
+ export declare const upsertQuery = "\n INSERT INTO \"documents\" (\"name\", \"data\") VALUES ($name, $data)\n ON CONFLICT(name) DO UPDATE SET data = $data\n";
3
6
  export interface SQLiteConfiguration extends DatabaseConfiguration {
4
7
  /**
5
8
  * Valid values are filenames, ":memory:" for an anonymous in-memory database and an empty
@@ -17,10 +20,7 @@ export interface SQLiteConfiguration extends DatabaseConfiguration {
17
20
  export declare class SQLite extends Database {
18
21
  db?: sqlite3.Database;
19
22
  configuration: SQLiteConfiguration;
20
- /**
21
- * Constructor
22
- */
23
23
  constructor(configuration?: Partial<SQLiteConfiguration>);
24
- onListen(): Promise<void>;
25
24
  onConfigure(): Promise<void>;
25
+ onListen(): Promise<void>;
26
26
  }
@@ -1,12 +1,16 @@
1
1
  import { Extension, onConnectPayload } from '@hocuspocus/server';
2
- export interface Configuration {
2
+ export interface ThrottleConfiguration {
3
3
  throttle: number | null | false;
4
4
  banTime: number;
5
5
  }
6
6
  export declare class Throttle implements Extension {
7
- configuration: Configuration;
7
+ configuration: ThrottleConfiguration;
8
8
  connectionsByIp: Map<string, Array<number>>;
9
9
  bannedIps: Map<string, number>;
10
+ /**
11
+ * Constructor
12
+ */
13
+ constructor(configuration?: Partial<ThrottleConfiguration>);
10
14
  /**
11
15
  * Throttle requests
12
16
  * @private
@@ -3,7 +3,6 @@ import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, on
3
3
  import { Doc } from 'yjs';
4
4
  import { Transformer } from '@hocuspocus/transformer';
5
5
  import { AxiosResponse } from 'axios';
6
- import Timeout = NodeJS.Timeout;
7
6
  export declare enum Events {
8
7
  onChange = "change",
9
8
  onConnect = "connect",
@@ -24,7 +23,7 @@ export interface Configuration {
24
23
  export declare class Webhook implements Extension {
25
24
  configuration: Configuration;
26
25
  debounced: Map<string, {
27
- timeout: Timeout;
26
+ timeout: NodeJS.Timeout;
28
27
  start: number;
29
28
  }>;
30
29
  /**
@@ -5,5 +5,5 @@ export default class EventEmitter {
5
5
  on(event: string, fn: Function): this;
6
6
  protected emit(event: string, ...args: any): this;
7
7
  off(event: string, fn?: Function): this;
8
- protected removeAllListeners(): void;
8
+ removeAllListeners(): void;
9
9
  }
@@ -1,10 +1,11 @@
1
- import { HocuspocusProvider, HocuspocusProviderOptions } from './HocuspocusProvider';
2
- export interface HocuspocusCloudProviderOptions extends HocuspocusProviderOptions {
1
+ import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
2
+ export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & AdditionalHocuspocusCloudProviderConfiguration;
3
+ export interface AdditionalHocuspocusCloudProviderConfiguration {
3
4
  /**
4
5
  * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
5
6
  */
6
7
  key: string;
7
8
  }
8
9
  export declare class HocuspocusCloudProvider extends HocuspocusProvider {
9
- constructor(options: HocuspocusCloudProviderOptions);
10
+ constructor(configuration: HocuspocusCloudProviderConfiguration);
10
11
  }
@@ -1,16 +1,12 @@
1
1
  import * as Y from 'yjs';
2
2
  import { Awareness } from 'y-protocols/awareness';
3
3
  import * as mutex from 'lib0/mutex';
4
- import { Event, CloseEvent, MessageEvent } from 'ws';
4
+ import type { Event, CloseEvent, MessageEvent } from 'ws';
5
5
  import EventEmitter from './EventEmitter';
6
- import { OutgoingMessage } from './OutgoingMessage';
7
- import { ConstructableOutgoingMessage } from './types';
8
- export declare enum WebSocketStatus {
9
- Connecting = "connecting",
10
- Connected = "connected",
11
- Disconnected = "disconnected"
12
- }
13
- export interface HocuspocusProviderOptions {
6
+ import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
7
+ import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
8
+ export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
9
+ export interface CompleteHocuspocusProviderConfiguration {
14
10
  /**
15
11
  * URL of your @hocuspocus/server instance
16
12
  */
@@ -90,23 +86,25 @@ export interface HocuspocusProviderOptions {
90
86
  */
91
87
  timeout: number;
92
88
  onAuthenticated: () => void;
93
- onAuthenticationFailed: ({ reason }: {
94
- reason: string;
95
- }) => void;
96
- onOpen: (event: Event) => void;
89
+ onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
90
+ onOpen: (data: onOpenParameters) => void;
97
91
  onConnect: () => void;
98
- onMessage: (event: MessageEvent) => void;
99
- onOutgoingMessage: (message: OutgoingMessage) => void;
100
- onStatus: (status: any) => void;
101
- onSynced: () => void;
102
- onDisconnect: (event: CloseEvent) => void;
103
- onClose: (event: CloseEvent) => void;
92
+ onMessage: (data: onMessageParameters) => void;
93
+ onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
94
+ onStatus: (data: onStatusParameters) => void;
95
+ onSynced: (data: onSyncedParameters) => void;
96
+ onDisconnect: (data: onDisconnectParameters) => void;
97
+ onClose: (data: onCloseParameters) => void;
104
98
  onDestroy: () => void;
105
- onAwarenessUpdate: (states: any) => void;
106
- onAwarenessChange: (states: any) => void;
99
+ onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
100
+ onAwarenessChange: (data: onAwarenessChangeParameters) => void;
101
+ /**
102
+ * Don’t output any warnings.
103
+ */
104
+ quiet: boolean;
107
105
  }
108
106
  export declare class HocuspocusProvider extends EventEmitter {
109
- options: HocuspocusProviderOptions;
107
+ configuration: CompleteHocuspocusProviderConfiguration;
110
108
  subscribedToBroadcastChannel: boolean;
111
109
  webSocket: WebSocket | null;
112
110
  shouldConnect: boolean;
@@ -120,11 +118,12 @@ export declare class HocuspocusProvider extends EventEmitter {
120
118
  resolve: (value?: any) => void;
121
119
  reject: (reason?: any) => void;
122
120
  } | null;
123
- constructor(options?: Partial<HocuspocusProviderOptions>);
124
- setOptions(options?: Partial<HocuspocusProviderOptions>): void;
121
+ constructor(configuration: HocuspocusProviderConfiguration);
122
+ setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
125
123
  connect(): Promise<void>;
126
124
  createWebSocketConnection(): Promise<unknown>;
127
125
  resolveConnectionAttempt(): void;
126
+ stopConnectionAttempt(): void;
128
127
  rejectConnectionAttempt(): void;
129
128
  get document(): Y.Doc;
130
129
  get awareness(): Awareness;
@@ -141,9 +140,8 @@ export declare class HocuspocusProvider extends EventEmitter {
141
140
  set synced(state: boolean);
142
141
  get isAuthenticationRequired(): boolean;
143
142
  disconnect(): void;
144
- onOpen(event: Event): void;
143
+ onOpen(event: Event): Promise<void>;
145
144
  getToken(): Promise<string | null>;
146
- webSocketConnectionEstablished(): Promise<void>;
147
145
  startSync(): void;
148
146
  send(Message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
149
147
  onMessage(event: MessageEvent): void;
@@ -1,4 +1,3 @@
1
1
  export * from './HocuspocusProvider';
2
2
  export * from './HocuspocusCloudProvider';
3
3
  export * from './types';
4
- export * from './utils';
@@ -1,18 +1,26 @@
1
1
  import { Awareness } from 'y-protocols/awareness';
2
2
  import * as Y from 'yjs';
3
3
  import { Encoder } from 'lib0/encoding';
4
+ import type { Event, CloseEvent, MessageEvent } from 'ws';
4
5
  import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage';
5
6
  import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage';
6
7
  import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage';
7
8
  import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage';
8
9
  import { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage';
9
10
  import { UpdateMessage } from './OutgoingMessages/UpdateMessage';
11
+ import { IncomingMessage } from './IncomingMessage';
12
+ import { OutgoingMessage } from './OutgoingMessage';
10
13
  export declare enum MessageType {
11
14
  Sync = 0,
12
15
  Awareness = 1,
13
16
  Auth = 2,
14
17
  QueryAwareness = 3
15
18
  }
19
+ export declare enum WebSocketStatus {
20
+ Connecting = "connecting",
21
+ Connected = "connected",
22
+ Disconnected = "disconnected"
23
+ }
16
24
  export interface OutgoingMessageInterface {
17
25
  encoder: Encoder;
18
26
  type?: MessageType;
@@ -32,3 +40,38 @@ export interface Constructable<T> {
32
40
  new (...args: any): T;
33
41
  }
34
42
  export declare type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
43
+ export declare type onAuthenticationFailedParameters = {
44
+ reason: string;
45
+ };
46
+ export declare type onOpenParameters = {
47
+ event: Event;
48
+ };
49
+ export declare type onMessageParameters = {
50
+ event: MessageEvent;
51
+ message: IncomingMessage;
52
+ };
53
+ export declare type onOutgoingMessageParameters = {
54
+ message: OutgoingMessage;
55
+ };
56
+ export declare type onStatusParameters = {
57
+ status: WebSocketStatus;
58
+ };
59
+ export declare type onSyncedParameters = {
60
+ state: boolean;
61
+ };
62
+ export declare type onDisconnectParameters = {
63
+ event: CloseEvent;
64
+ };
65
+ export declare type onCloseParameters = {
66
+ event: CloseEvent;
67
+ };
68
+ export declare type onAwarenessUpdateParameters = {
69
+ states: StatesArray;
70
+ };
71
+ export declare type onAwarenessChangeParameters = {
72
+ states: StatesArray;
73
+ };
74
+ export declare type StatesArray = {
75
+ clientId: number;
76
+ [key: string | number]: any;
77
+ }[];
@@ -2,10 +2,10 @@
2
2
  import AsyncLock from 'async-lock';
3
3
  import WebSocket from 'ws';
4
4
  import { IncomingMessage as HTTPIncomingMessage } from 'http';
5
+ import { CloseEvent } from '@hocuspocus/common';
5
6
  import Document from './Document';
6
- import { CloseEvent } from './types';
7
- import { MessageLogger } from './Debugger';
8
- declare class Connection {
7
+ import { Debugger } from './Debugger';
8
+ export declare class Connection {
9
9
  webSocket: WebSocket;
10
10
  context: any;
11
11
  document: Document;
@@ -17,11 +17,11 @@ declare class Connection {
17
17
  socketId: string;
18
18
  lock: AsyncLock;
19
19
  readOnly: Boolean;
20
- debugger: MessageLogger;
20
+ logger: Debugger;
21
21
  /**
22
22
  * Constructor.
23
23
  */
24
- constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly?: boolean);
24
+ constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly: boolean | undefined, logger: Debugger);
25
25
  /**
26
26
  * Set a callback that will be triggered when the connection is closed
27
27
  */
@@ -1,4 +1,4 @@
1
- export declare class MessageLogger {
1
+ export declare class Debugger {
2
2
  logs: any[];
3
3
  listen: boolean;
4
4
  output: boolean;
@@ -12,4 +12,3 @@ export declare class MessageLogger {
12
12
  logs: any[];
13
13
  };
14
14
  }
15
- export declare const Debugger: MessageLogger;