@hocuspocus/extension-sqlite 1.0.0-alpha.1 → 1.0.0-alpha.10
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.
- package/dist/hocuspocus-sqlite.cjs +29 -20
- package/dist/hocuspocus-sqlite.cjs.map +1 -1
- package/dist/hocuspocus-sqlite.esm.js +26 -20
- package/dist/hocuspocus-sqlite.esm.js.map +1 -1
- package/dist/packages/common/src/CloseEvents.d.ts +23 -0
- package/dist/packages/common/src/awarenessStatesToArray.d.ts +3 -0
- package/dist/packages/common/src/index.d.ts +3 -0
- package/dist/packages/common/src/types.d.ts +10 -0
- package/dist/packages/extension-database/src/Database.d.ts +5 -9
- package/dist/packages/extension-logger/src/Logger.d.ts +5 -0
- package/dist/packages/extension-monitor/src/index.d.ts +2 -2
- package/dist/packages/extension-sqlite/src/SQLite.d.ts +4 -4
- package/dist/packages/extension-throttle/src/index.d.ts +6 -2
- package/dist/packages/extension-webhook/src/index.d.ts +1 -2
- package/dist/packages/provider/src/EventEmitter.d.ts +1 -1
- package/dist/packages/provider/src/HocuspocusCloudProvider.d.ts +4 -3
- package/dist/packages/provider/src/HocuspocusProvider.d.ts +18 -10
- package/dist/packages/provider/src/index.d.ts +0 -1
- package/dist/packages/provider/src/types.d.ts +10 -0
- package/dist/packages/server/src/Connection.d.ts +5 -5
- package/dist/packages/server/src/Debugger.d.ts +1 -2
- package/dist/packages/server/src/Document.d.ts +8 -5
- package/dist/packages/server/src/Hocuspocus.d.ts +32 -14
- package/dist/packages/server/src/MessageReceiver.d.ts +8 -5
- package/dist/packages/server/src/OutgoingMessage.d.ts +1 -0
- package/dist/packages/server/src/index.d.ts +7 -0
- package/dist/packages/server/src/types.d.ts +92 -33
- package/dist/tests/extension-logger/onListen.d.ts +1 -0
- package/dist/tests/extension-redis/onLoadDocument.d.ts +1 -0
- package/dist/tests/extension-redis/onSynced.d.ts +1 -0
- package/dist/tests/extension-redis-rewrite/closeConnections.d.ts +1 -0
- package/dist/tests/extension-redis-rewrite/getConnectionCount.d.ts +1 -0
- package/dist/tests/extension-redis-rewrite/getDocumentsCount.d.ts +1 -0
- package/dist/tests/extension-redis-rewrite/onAwarenessChange.d.ts +1 -0
- package/dist/tests/extension-redis-rewrite/onChange.d.ts +1 -0
- package/dist/tests/extension-redis-rewrite/onStoreDocument.d.ts +1 -0
- package/dist/tests/extension-rocksdb/onLoadDocument.d.ts +1 -0
- package/dist/tests/extension-throttle/configuration.d.ts +1 -0
- package/dist/tests/provider/configuration.d.ts +1 -0
- package/dist/tests/provider/observe.d.ts +1 -0
- package/dist/tests/provider/observeDeep.d.ts +1 -0
- package/dist/tests/provider/onAuthenticated.d.ts +1 -0
- package/dist/tests/provider/onAuthenticationFailed.d.ts +1 -0
- package/dist/tests/provider/onAwarenessChange.d.ts +1 -0
- package/dist/tests/provider/onAwarenessUpdate.d.ts +1 -0
- package/dist/tests/provider/onClose.d.ts +1 -0
- package/dist/tests/provider/onConnect.d.ts +1 -0
- package/dist/tests/provider/onDisconnect.d.ts +1 -0
- package/dist/tests/provider/onMessage.d.ts +1 -0
- package/dist/tests/provider/onOpen.d.ts +1 -0
- package/dist/tests/provider/onSynced.d.ts +1 -0
- package/dist/tests/server/address.d.ts +1 -0
- package/dist/tests/server/afterStoreDocument.d.ts +1 -0
- package/dist/tests/server/closeConnections.d.ts +1 -0
- package/dist/tests/server/getConnectionsCount.d.ts +1 -0
- package/dist/tests/server/getDocumentName.d.ts +1 -0
- package/dist/tests/server/getDocumentsCount.d.ts +1 -0
- package/dist/tests/server/getMessageLogs.d.ts +1 -0
- package/dist/tests/server/listen.d.ts +1 -0
- package/dist/tests/server/onAuthenticate.d.ts +1 -0
- package/dist/tests/server/onAwarenessUpdate.d.ts +1 -0
- package/dist/tests/server/onChange.d.ts +1 -0
- package/dist/tests/server/onConfigure.d.ts +1 -0
- package/dist/tests/server/onConnect.d.ts +1 -0
- package/dist/tests/server/onDestroy.d.ts +1 -0
- package/dist/tests/server/onDisconnect.d.ts +1 -0
- package/dist/tests/server/onListen.d.ts +1 -0
- package/dist/tests/server/onLoadDocument.d.ts +1 -0
- package/dist/tests/server/onRequest.d.ts +1 -0
- package/dist/tests/server/onStoreDocument.d.ts +1 -0
- package/dist/tests/server/onUpgrade.d.ts +1 -0
- package/dist/tests/server/requiresAuthentication.d.ts +1 -0
- package/dist/tests/transformer/TiptapTransformer.d.ts +1 -0
- package/dist/tests/utils/createDirectory.d.ts +1 -0
- package/dist/tests/utils/flushRedis.d.ts +1 -0
- package/dist/tests/utils/index.d.ts +7 -0
- package/dist/tests/utils/newHocuspocus.d.ts +2 -0
- package/dist/tests/utils/newHocuspocusProvider.d.ts +3 -0
- package/dist/tests/utils/redisConnectionSettings.d.ts +4 -0
- package/dist/tests/utils/removeDirectory.d.ts +1 -0
- package/dist/tests/utils/sleep.d.ts +1 -0
- package/package.json +5 -5
- package/src/SQLite.ts +29 -21
- package/dist/packages/provider/src/utils/awarenessStatesToArray.d.ts +0 -4
- package/dist/packages/provider/src/utils/index.d.ts +0 -1
- 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
|
|
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
|
|
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
|
|
23
|
-
|
|
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.
|
|
35
|
+
(_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
|
|
30
36
|
$name: documentName,
|
|
31
|
-
}, (error,
|
|
37
|
+
}, (error, row) => {
|
|
32
38
|
if (error) {
|
|
33
39
|
reject(error);
|
|
34
40
|
}
|
|
35
|
-
resolve(
|
|
41
|
+
resolve(row === null || row === void 0 ? void 0 : row.data);
|
|
36
42
|
});
|
|
37
43
|
});
|
|
38
44
|
},
|
|
39
|
-
|
|
45
|
+
store: async ({ documentName, state }) => {
|
|
40
46
|
var _a;
|
|
41
|
-
(_a = this.db) === null || _a === void 0 ? void 0 : _a.run(
|
|
47
|
+
(_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
|
|
42
48
|
$name: documentName,
|
|
43
|
-
$data:
|
|
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
|
|
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":";;;;;;;;;;;;;MAIa,MAAM,GAAG;;;;GAIpB;MAEW,WAAW,GAAG;;EAE1B;MAEY,WAAW,GAAG;;;EAG1B;MAiBY,MAAO,SAAQA,0BAAQ;IA2BlC,YAAY,aAA4C;QACtD,KAAK,CAAC,EAAE,CAAC,CAAA;QAzBX,kBAAa,GAAwB;YACnC,QAAQ,EAAE,UAAU;YACpB,MAAM;YACN,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE;gBAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM;;oBACjC,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;wBACxB,KAAK,EAAE,YAAY;qBACpB,EAAE,CAAC,KAAK,EAAE,GAAG;wBACZ,IAAI,KAAK,EAAE;4BACT,MAAM,CAAC,KAAK,CAAC,CAAA;yBACd;wBAED,OAAO,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC,CAAA;qBACnB,CAAC,CAAA;iBACH,CAAC,CAAA;aACH;YACD,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE;;gBACnC,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;oBACxB,KAAK,EAAE,YAAY;oBACnB,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;aACH;SACF,CAAA;QAKC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,WAAW;QACf,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;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;;;;;;;;"}
|
|
@@ -1,37 +1,43 @@
|
|
|
1
1
|
import { Database } from '@hocuspocus/extension-database';
|
|
2
2
|
import sqlite3 from 'sqlite3';
|
|
3
|
-
import
|
|
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
|
|
14
|
-
|
|
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.
|
|
26
|
+
(_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
|
|
21
27
|
$name: documentName,
|
|
22
|
-
}, (error,
|
|
28
|
+
}, (error, row) => {
|
|
23
29
|
if (error) {
|
|
24
30
|
reject(error);
|
|
25
31
|
}
|
|
26
|
-
resolve(
|
|
32
|
+
resolve(row === null || row === void 0 ? void 0 : row.data);
|
|
27
33
|
});
|
|
28
34
|
});
|
|
29
35
|
},
|
|
30
|
-
|
|
36
|
+
store: async ({ documentName, state }) => {
|
|
31
37
|
var _a;
|
|
32
|
-
(_a = this.db) === null || _a === void 0 ? void 0 : _a.run(
|
|
38
|
+
(_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
|
|
33
39
|
$name: documentName,
|
|
34
|
-
$data:
|
|
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
|
|
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":";;;;MAIa,MAAM,GAAG;;;;GAIpB;MAEW,WAAW,GAAG;;EAE1B;MAEY,WAAW,GAAG;;;EAG1B;MAiBY,MAAO,SAAQ,QAAQ;IA2BlC,YAAY,aAA4C;QACtD,KAAK,CAAC,EAAE,CAAC,CAAA;QAzBX,kBAAa,GAAwB;YACnC,QAAQ,EAAE,UAAU;YACpB,MAAM;YACN,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE;gBAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM;;oBACjC,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;wBACxB,KAAK,EAAE,YAAY;qBACpB,EAAE,CAAC,KAAK,EAAE,GAAG;wBACZ,IAAI,KAAK,EAAE;4BACT,MAAM,CAAC,KAAK,CAAC,CAAA;yBACd;wBAED,OAAO,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC,CAAA;qBACnB,CAAC,CAAA;iBACH,CAAC,CAAA;aACH;YACD,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE;;gBACnC,MAAA,IAAI,CAAC,EAAE,0CAAE,GAAG,CAAC,WAAW,EAAE;oBACxB,KAAK,EAAE,YAAY;oBACnB,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;aACH;SACF,CAAA;QAKC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,WAAW;QACf,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;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;;;;;"}
|
|
@@ -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;
|
|
@@ -1,20 +1,16 @@
|
|
|
1
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { Extension, onChangePayload, onConfigurePayload,
|
|
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
|
-
|
|
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
|
|
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:
|
|
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
|
/**
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import { HocuspocusProvider,
|
|
2
|
-
export
|
|
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(
|
|
10
|
+
constructor(configuration: HocuspocusCloudProviderConfiguration);
|
|
10
11
|
}
|
|
@@ -1,16 +1,18 @@
|
|
|
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
6
|
import { OutgoingMessage } from './OutgoingMessage';
|
|
7
7
|
import { ConstructableOutgoingMessage } from './types';
|
|
8
|
+
import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
|
|
8
9
|
export declare enum WebSocketStatus {
|
|
9
10
|
Connecting = "connecting",
|
|
10
11
|
Connected = "connected",
|
|
11
12
|
Disconnected = "disconnected"
|
|
12
13
|
}
|
|
13
|
-
export
|
|
14
|
+
export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
|
|
15
|
+
export interface CompleteHocuspocusProviderConfiguration {
|
|
14
16
|
/**
|
|
15
17
|
* URL of your @hocuspocus/server instance
|
|
16
18
|
*/
|
|
@@ -98,15 +100,21 @@ export interface HocuspocusProviderOptions {
|
|
|
98
100
|
onMessage: (event: MessageEvent) => void;
|
|
99
101
|
onOutgoingMessage: (message: OutgoingMessage) => void;
|
|
100
102
|
onStatus: (status: any) => void;
|
|
101
|
-
onSynced: (
|
|
103
|
+
onSynced: ({ state }: {
|
|
104
|
+
state: boolean;
|
|
105
|
+
}) => void;
|
|
102
106
|
onDisconnect: (event: CloseEvent) => void;
|
|
103
107
|
onClose: (event: CloseEvent) => void;
|
|
104
108
|
onDestroy: () => void;
|
|
105
|
-
onAwarenessUpdate: (states:
|
|
106
|
-
onAwarenessChange: (states:
|
|
109
|
+
onAwarenessUpdate: ({ states }: onAwarenessUpdateParameters) => void;
|
|
110
|
+
onAwarenessChange: ({ states }: onAwarenessChangeParameters) => void;
|
|
111
|
+
/**
|
|
112
|
+
* Don’t output any warnings.
|
|
113
|
+
*/
|
|
114
|
+
quiet: boolean;
|
|
107
115
|
}
|
|
108
116
|
export declare class HocuspocusProvider extends EventEmitter {
|
|
109
|
-
|
|
117
|
+
configuration: CompleteHocuspocusProviderConfiguration;
|
|
110
118
|
subscribedToBroadcastChannel: boolean;
|
|
111
119
|
webSocket: WebSocket | null;
|
|
112
120
|
shouldConnect: boolean;
|
|
@@ -120,11 +128,12 @@ export declare class HocuspocusProvider extends EventEmitter {
|
|
|
120
128
|
resolve: (value?: any) => void;
|
|
121
129
|
reject: (reason?: any) => void;
|
|
122
130
|
} | null;
|
|
123
|
-
constructor(
|
|
124
|
-
|
|
131
|
+
constructor(configuration: HocuspocusProviderConfiguration);
|
|
132
|
+
setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
|
|
125
133
|
connect(): Promise<void>;
|
|
126
134
|
createWebSocketConnection(): Promise<unknown>;
|
|
127
135
|
resolveConnectionAttempt(): void;
|
|
136
|
+
stopConnectionAttempt(): void;
|
|
128
137
|
rejectConnectionAttempt(): void;
|
|
129
138
|
get document(): Y.Doc;
|
|
130
139
|
get awareness(): Awareness;
|
|
@@ -141,9 +150,8 @@ export declare class HocuspocusProvider extends EventEmitter {
|
|
|
141
150
|
set synced(state: boolean);
|
|
142
151
|
get isAuthenticationRequired(): boolean;
|
|
143
152
|
disconnect(): void;
|
|
144
|
-
onOpen(event: Event): void
|
|
153
|
+
onOpen(event: Event): Promise<void>;
|
|
145
154
|
getToken(): Promise<string | null>;
|
|
146
|
-
webSocketConnectionEstablished(): Promise<void>;
|
|
147
155
|
startSync(): void;
|
|
148
156
|
send(Message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
|
|
149
157
|
onMessage(event: MessageEvent): void;
|
|
@@ -32,3 +32,13 @@ export interface Constructable<T> {
|
|
|
32
32
|
new (...args: any): T;
|
|
33
33
|
}
|
|
34
34
|
export declare type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
|
|
35
|
+
export declare type onAwarenessUpdateParameters = {
|
|
36
|
+
states: StatesArray;
|
|
37
|
+
};
|
|
38
|
+
export declare type onAwarenessChangeParameters = {
|
|
39
|
+
states: StatesArray;
|
|
40
|
+
};
|
|
41
|
+
export declare type StatesArray = {
|
|
42
|
+
clientId: number;
|
|
43
|
+
[key: string | number]: any;
|
|
44
|
+
}[];
|
|
@@ -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 {
|
|
7
|
-
|
|
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
|
-
|
|
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
|
|
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
|
*/
|
|
@@ -3,20 +3,23 @@ import { Awareness } from 'y-protocols/awareness';
|
|
|
3
3
|
import { Doc } from 'yjs';
|
|
4
4
|
import { mutex } from 'lib0/mutex.js';
|
|
5
5
|
import Connection from './Connection';
|
|
6
|
-
import {
|
|
7
|
-
declare class Document extends Doc {
|
|
6
|
+
import { Debugger } from './Debugger';
|
|
7
|
+
export declare class Document extends Doc {
|
|
8
8
|
awareness: Awareness;
|
|
9
9
|
callbacks: {
|
|
10
10
|
onUpdate: (document: Document, connection: Connection, update: Uint8Array) => void;
|
|
11
11
|
};
|
|
12
|
-
connections: Map<
|
|
12
|
+
connections: Map<WebSocket, {
|
|
13
|
+
clients: Set<any>;
|
|
14
|
+
connection: Connection;
|
|
15
|
+
}>;
|
|
13
16
|
name: string;
|
|
14
17
|
mux: mutex;
|
|
15
|
-
|
|
18
|
+
logger: Debugger;
|
|
16
19
|
/**
|
|
17
20
|
* Constructor.
|
|
18
21
|
*/
|
|
19
|
-
constructor(name: string);
|
|
22
|
+
constructor(name: string, logger: Debugger);
|
|
20
23
|
/**
|
|
21
24
|
* Check if the Document is empty
|
|
22
25
|
*/
|