@hocuspocus/extension-sqlite 2.1.0-alpha.0 → 2.2.0

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 (127) hide show
  1. package/dist/hocuspocus-sqlite.cjs +46 -46
  2. package/dist/hocuspocus-sqlite.esm.js +46 -46
  3. package/dist/packages/common/src/CloseEvents.d.ts +29 -29
  4. package/dist/packages/common/src/auth.d.ts +6 -6
  5. package/dist/packages/common/src/awarenessStatesToArray.d.ts +3 -3
  6. package/dist/packages/common/src/index.d.ts +4 -4
  7. package/dist/packages/common/src/types.d.ts +10 -10
  8. package/dist/packages/extension-database/src/Database.d.ts +30 -30
  9. package/dist/packages/extension-database/src/index.d.ts +1 -1
  10. package/dist/packages/extension-logger/src/Logger.d.ts +67 -67
  11. package/dist/packages/extension-logger/src/index.d.ts +1 -1
  12. package/dist/packages/extension-redis/src/Redis.d.ts +116 -95
  13. package/dist/packages/extension-redis/src/index.d.ts +1 -1
  14. package/dist/packages/extension-sqlite/src/SQLite.d.ts +26 -26
  15. package/dist/packages/extension-sqlite/src/index.d.ts +1 -1
  16. package/dist/packages/extension-throttle/src/index.d.ts +31 -31
  17. package/dist/packages/extension-webhook/src/index.d.ts +57 -57
  18. package/dist/packages/provider/src/EventEmitter.d.ts +9 -9
  19. package/dist/packages/provider/src/HocuspocusProvider.d.ts +110 -110
  20. package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts +115 -115
  21. package/dist/packages/provider/src/IncomingMessage.d.ts +16 -16
  22. package/dist/packages/provider/src/MessageReceiver.d.ts +13 -13
  23. package/dist/packages/provider/src/MessageSender.d.ts +10 -10
  24. package/dist/packages/provider/src/OutgoingMessage.d.ts +9 -9
  25. package/dist/packages/provider/src/OutgoingMessages/AuthenticationMessage.d.ts +7 -7
  26. package/dist/packages/provider/src/OutgoingMessages/AwarenessMessage.d.ts +8 -8
  27. package/dist/packages/provider/src/OutgoingMessages/CloseMessage.d.ts +8 -8
  28. package/dist/packages/provider/src/OutgoingMessages/QueryAwarenessMessage.d.ts +8 -8
  29. package/dist/packages/provider/src/OutgoingMessages/StatelessMessage.d.ts +7 -7
  30. package/dist/packages/provider/src/OutgoingMessages/SyncStepOneMessage.d.ts +8 -8
  31. package/dist/packages/provider/src/OutgoingMessages/SyncStepTwoMessage.d.ts +8 -8
  32. package/dist/packages/provider/src/OutgoingMessages/UpdateMessage.d.ts +7 -7
  33. package/dist/packages/provider/src/TiptapCollabProvider.d.ts +11 -11
  34. package/dist/packages/provider/src/TiptapCollabProviderWebsocket.d.ts +11 -11
  35. package/dist/packages/provider/src/index.d.ts +5 -5
  36. package/dist/packages/provider/src/types.d.ts +84 -84
  37. package/dist/packages/server/src/ClientConnection.d.ts +56 -0
  38. package/dist/packages/server/src/Connection.d.ts +71 -71
  39. package/dist/packages/server/src/Debugger.d.ts +14 -14
  40. package/dist/packages/server/src/DirectConnection.d.ts +14 -0
  41. package/dist/packages/server/src/Document.d.ts +91 -88
  42. package/dist/packages/server/src/Hocuspocus.d.ts +103 -108
  43. package/dist/packages/server/src/IncomingMessage.d.ts +21 -21
  44. package/dist/packages/server/src/MessageReceiver.d.ts +12 -12
  45. package/dist/packages/server/src/OutgoingMessage.d.ts +20 -20
  46. package/dist/packages/server/src/index.d.ts +8 -8
  47. package/dist/packages/server/src/types.d.ts +270 -264
  48. package/dist/packages/server/src/util/getParameters.d.ts +8 -0
  49. package/dist/packages/transformer/src/Prosemirror.d.ts +11 -11
  50. package/dist/packages/transformer/src/Tiptap.d.ts +10 -10
  51. package/dist/packages/transformer/src/index.d.ts +3 -3
  52. package/dist/packages/transformer/src/types.d.ts +5 -5
  53. package/dist/playground/backend/src/default.d.ts +1 -1
  54. package/dist/playground/backend/src/express.d.ts +1 -1
  55. package/dist/playground/backend/src/koa.d.ts +1 -1
  56. package/dist/playground/backend/src/load-document.d.ts +1 -1
  57. package/dist/playground/backend/src/redis.d.ts +1 -1
  58. package/dist/playground/backend/src/slow.d.ts +1 -1
  59. package/dist/playground/backend/src/tiptapcollab.d.ts +1 -1
  60. package/dist/playground/backend/src/webhook.d.ts +1 -1
  61. package/dist/playground/frontend/src/main.d.ts +1 -1
  62. package/dist/playground/frontend/vite.config.d.ts +2 -2
  63. package/dist/tests/extension-database/fetch.d.ts +1 -1
  64. package/dist/tests/extension-logger/onListen.d.ts +1 -1
  65. package/dist/tests/extension-redis/closeConnections.d.ts +1 -1
  66. package/dist/tests/extension-redis/getConnectionCount.d.ts +1 -1
  67. package/dist/tests/extension-redis/getDocumentsCount.d.ts +1 -1
  68. package/dist/tests/extension-redis/onAwarenessChange.d.ts +1 -1
  69. package/dist/tests/extension-redis/onChange.d.ts +1 -1
  70. package/dist/tests/extension-redis/onStateless.d.ts +1 -1
  71. package/dist/tests/extension-redis/onStoreDocument.d.ts +1 -1
  72. package/dist/tests/extension-throttle/banning.d.ts +1 -1
  73. package/dist/tests/extension-throttle/configuration.d.ts +1 -1
  74. package/dist/tests/provider/observe.d.ts +1 -1
  75. package/dist/tests/provider/observeDeep.d.ts +1 -1
  76. package/dist/tests/provider/onAuthenticated.d.ts +1 -1
  77. package/dist/tests/provider/onAuthenticationFailed.d.ts +1 -1
  78. package/dist/tests/provider/onAwarenessChange.d.ts +1 -1
  79. package/dist/tests/provider/onAwarenessUpdate.d.ts +1 -1
  80. package/dist/tests/provider/onClose.d.ts +1 -1
  81. package/dist/tests/provider/onConnect.d.ts +1 -1
  82. package/dist/tests/provider/onDisconnect.d.ts +1 -1
  83. package/dist/tests/provider/onMessage.d.ts +1 -1
  84. package/dist/tests/provider/onOpen.d.ts +1 -1
  85. package/dist/tests/provider/onStateless.d.ts +1 -1
  86. package/dist/tests/provider/onSynced.d.ts +1 -1
  87. package/dist/tests/providerwebsocket/configuration.d.ts +1 -1
  88. package/dist/tests/server/address.d.ts +1 -1
  89. package/dist/tests/server/afterStoreDocument.d.ts +1 -1
  90. package/dist/tests/server/beforeBroadcastStateless.d.ts +1 -1
  91. package/dist/tests/server/beforeHandleMessage.d.ts +1 -1
  92. package/dist/tests/server/closeConnections.d.ts +1 -1
  93. package/dist/tests/server/getConnectionsCount.d.ts +1 -1
  94. package/dist/tests/server/getDocumentsCount.d.ts +1 -1
  95. package/dist/tests/server/getMessageLogs.d.ts +1 -1
  96. package/dist/tests/server/listen.d.ts +1 -1
  97. package/dist/tests/server/onAuthenticate.d.ts +1 -1
  98. package/dist/tests/server/onAwarenessUpdate.d.ts +1 -1
  99. package/dist/tests/server/onChange.d.ts +1 -1
  100. package/dist/tests/server/onClose.d.ts +1 -1
  101. package/dist/tests/server/onConfigure.d.ts +1 -1
  102. package/dist/tests/server/onConnect.d.ts +1 -1
  103. package/dist/tests/server/onDestroy.d.ts +1 -1
  104. package/dist/tests/server/onDisconnect.d.ts +1 -1
  105. package/dist/tests/server/onListen.d.ts +1 -1
  106. package/dist/tests/server/onLoadDocument.d.ts +1 -1
  107. package/dist/tests/server/onRequest.d.ts +1 -1
  108. package/dist/tests/server/onStateless.d.ts +1 -1
  109. package/dist/tests/server/onStoreDocument.d.ts +1 -1
  110. package/dist/tests/server/onUpgrade.d.ts +1 -1
  111. package/dist/tests/server/openDirectConnection.d.ts +1 -0
  112. package/dist/tests/server/requiresAuthentication.d.ts +1 -1
  113. package/dist/tests/server/websocketError.d.ts +1 -1
  114. package/dist/tests/transformer/TiptapTransformer.d.ts +1 -1
  115. package/dist/tests/utils/createDirectory.d.ts +1 -1
  116. package/dist/tests/utils/flushRedis.d.ts +1 -1
  117. package/dist/tests/utils/index.d.ts +9 -9
  118. package/dist/tests/utils/newHocuspocus.d.ts +2 -2
  119. package/dist/tests/utils/newHocuspocusProvider.d.ts +3 -3
  120. package/dist/tests/utils/newHocuspocusProviderWebsocket.d.ts +3 -3
  121. package/dist/tests/utils/randomInteger.d.ts +1 -1
  122. package/dist/tests/utils/redisConnectionSettings.d.ts +4 -4
  123. package/dist/tests/utils/removeDirectory.d.ts +1 -1
  124. package/dist/tests/utils/retryableAssertion.d.ts +2 -2
  125. package/dist/tests/utils/sleep.d.ts +1 -1
  126. package/package.json +4 -3
  127. package/src/index.ts +1 -1
@@ -15,57 +15,57 @@ const schema = `CREATE TABLE IF NOT EXISTS "documents" (
15
15
  "name" varchar(255) NOT NULL,
16
16
  "data" blob NOT NULL,
17
17
  UNIQUE(name)
18
- )`;
18
+ )`;
19
19
  const selectQuery = `
20
20
  SELECT data FROM "documents" WHERE name = $name ORDER BY rowid DESC
21
- `;
21
+ `;
22
22
  const upsertQuery = `
23
23
  INSERT INTO "documents" ("name", "data") VALUES ($name, $data)
24
24
  ON CONFLICT(name) DO UPDATE SET data = $data
25
- `;
26
- const SQLITE_INMEMORY = ':memory:';
27
- class SQLite extends extensionDatabase.Database {
28
- constructor(configuration) {
29
- super({});
30
- this.configuration = {
31
- database: SQLITE_INMEMORY,
32
- schema,
33
- fetch: async ({ documentName }) => {
34
- return new Promise((resolve, reject) => {
35
- var _a;
36
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
37
- $name: documentName,
38
- }, (error, row) => {
39
- if (error) {
40
- reject(error);
41
- }
42
- resolve(row === null || row === void 0 ? void 0 : row.data);
43
- });
44
- });
45
- },
46
- store: async ({ documentName, state }) => {
47
- var _a;
48
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
49
- $name: documentName,
50
- $data: state,
51
- });
52
- },
53
- };
54
- this.configuration = {
55
- ...this.configuration,
56
- ...configuration,
57
- };
58
- }
59
- async onConfigure() {
60
- this.db = new sqlite3__default["default"].Database(this.configuration.database);
61
- this.db.run(this.configuration.schema);
62
- }
63
- async onListen() {
64
- if (this.configuration.database === SQLITE_INMEMORY) {
65
- console.warn(` ${kleur__default["default"].yellow('The SQLite extension is configured as an in-memory database. All changes will be lost on restart!')}`);
66
- console.log();
67
- }
68
- }
25
+ `;
26
+ const SQLITE_INMEMORY = ':memory:';
27
+ class SQLite extends extensionDatabase.Database {
28
+ constructor(configuration) {
29
+ super({});
30
+ this.configuration = {
31
+ database: SQLITE_INMEMORY,
32
+ schema,
33
+ fetch: async ({ documentName }) => {
34
+ return new Promise((resolve, reject) => {
35
+ var _a;
36
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
37
+ $name: documentName,
38
+ }, (error, row) => {
39
+ if (error) {
40
+ reject(error);
41
+ }
42
+ resolve(row === null || row === void 0 ? void 0 : row.data);
43
+ });
44
+ });
45
+ },
46
+ store: async ({ documentName, state }) => {
47
+ var _a;
48
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
49
+ $name: documentName,
50
+ $data: state,
51
+ });
52
+ },
53
+ };
54
+ this.configuration = {
55
+ ...this.configuration,
56
+ ...configuration,
57
+ };
58
+ }
59
+ async onConfigure() {
60
+ this.db = new sqlite3__default["default"].Database(this.configuration.database);
61
+ this.db.run(this.configuration.schema);
62
+ }
63
+ async onListen() {
64
+ if (this.configuration.database === SQLITE_INMEMORY) {
65
+ console.warn(` ${kleur__default["default"].yellow('The SQLite extension is configured as an in-memory database. All changes will be lost on restart!')}`);
66
+ console.log();
67
+ }
68
+ }
69
69
  }
70
70
 
71
71
  exports.SQLite = SQLite;
@@ -6,57 +6,57 @@ const schema = `CREATE TABLE IF NOT EXISTS "documents" (
6
6
  "name" varchar(255) NOT NULL,
7
7
  "data" blob NOT NULL,
8
8
  UNIQUE(name)
9
- )`;
9
+ )`;
10
10
  const selectQuery = `
11
11
  SELECT data FROM "documents" WHERE name = $name ORDER BY rowid DESC
12
- `;
12
+ `;
13
13
  const upsertQuery = `
14
14
  INSERT INTO "documents" ("name", "data") VALUES ($name, $data)
15
15
  ON CONFLICT(name) DO UPDATE SET data = $data
16
- `;
17
- const SQLITE_INMEMORY = ':memory:';
18
- class SQLite extends Database {
19
- constructor(configuration) {
20
- super({});
21
- this.configuration = {
22
- database: SQLITE_INMEMORY,
23
- schema,
24
- fetch: async ({ documentName }) => {
25
- return new Promise((resolve, reject) => {
26
- var _a;
27
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
28
- $name: documentName,
29
- }, (error, row) => {
30
- if (error) {
31
- reject(error);
32
- }
33
- resolve(row === null || row === void 0 ? void 0 : row.data);
34
- });
35
- });
36
- },
37
- store: async ({ documentName, state }) => {
38
- var _a;
39
- (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
40
- $name: documentName,
41
- $data: state,
42
- });
43
- },
44
- };
45
- this.configuration = {
46
- ...this.configuration,
47
- ...configuration,
48
- };
49
- }
50
- async onConfigure() {
51
- this.db = new sqlite3.Database(this.configuration.database);
52
- this.db.run(this.configuration.schema);
53
- }
54
- async onListen() {
55
- if (this.configuration.database === SQLITE_INMEMORY) {
56
- console.warn(` ${kleur.yellow('The SQLite extension is configured as an in-memory database. All changes will be lost on restart!')}`);
57
- console.log();
58
- }
59
- }
16
+ `;
17
+ const SQLITE_INMEMORY = ':memory:';
18
+ class SQLite extends Database {
19
+ constructor(configuration) {
20
+ super({});
21
+ this.configuration = {
22
+ database: SQLITE_INMEMORY,
23
+ schema,
24
+ fetch: async ({ documentName }) => {
25
+ return new Promise((resolve, reject) => {
26
+ var _a;
27
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.get(selectQuery, {
28
+ $name: documentName,
29
+ }, (error, row) => {
30
+ if (error) {
31
+ reject(error);
32
+ }
33
+ resolve(row === null || row === void 0 ? void 0 : row.data);
34
+ });
35
+ });
36
+ },
37
+ store: async ({ documentName, state }) => {
38
+ var _a;
39
+ (_a = this.db) === null || _a === void 0 ? void 0 : _a.run(upsertQuery, {
40
+ $name: documentName,
41
+ $data: state,
42
+ });
43
+ },
44
+ };
45
+ this.configuration = {
46
+ ...this.configuration,
47
+ ...configuration,
48
+ };
49
+ }
50
+ async onConfigure() {
51
+ this.db = new sqlite3.Database(this.configuration.database);
52
+ this.db.run(this.configuration.schema);
53
+ }
54
+ async onListen() {
55
+ if (this.configuration.database === SQLITE_INMEMORY) {
56
+ console.warn(` ${kleur.yellow('The SQLite extension is configured as an in-memory database. All changes will be lost on restart!')}`);
57
+ console.log();
58
+ }
59
+ }
60
60
  }
61
61
 
62
62
  export { SQLite, schema, selectQuery, upsertQuery };
@@ -1,29 +1,29 @@
1
- export interface CloseEvent {
2
- code: number;
3
- reason: string;
4
- }
5
- /**
6
- * The server is terminating the connection because a data frame was received
7
- * that is too large.
8
- * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
9
- */
10
- export declare const MessageTooBig: CloseEvent;
11
- /**
12
- * The server successfully processed the request, asks that the requester reset
13
- * its document view, and is not returning any content.
14
- */
15
- export declare const ResetConnection: CloseEvent;
16
- /**
17
- * Similar to Forbidden, but specifically for use when authentication is required and has
18
- * failed or has not yet been provided.
19
- */
20
- export declare const Unauthorized: CloseEvent;
21
- /**
22
- * The request contained valid data and was understood by the server, but the server
23
- * is refusing action.
24
- */
25
- export declare const Forbidden: CloseEvent;
26
- /**
27
- * The server timed out waiting for the request.
28
- */
29
- export declare const ConnectionTimeout: CloseEvent;
1
+ export interface CloseEvent {
2
+ code: number;
3
+ reason: string;
4
+ }
5
+ /**
6
+ * The server is terminating the connection because a data frame was received
7
+ * that is too large.
8
+ * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
9
+ */
10
+ export declare const MessageTooBig: CloseEvent;
11
+ /**
12
+ * The server successfully processed the request, asks that the requester reset
13
+ * its document view, and is not returning any content.
14
+ */
15
+ export declare const ResetConnection: CloseEvent;
16
+ /**
17
+ * Similar to Forbidden, but specifically for use when authentication is required and has
18
+ * failed or has not yet been provided.
19
+ */
20
+ export declare const Unauthorized: CloseEvent;
21
+ /**
22
+ * The request contained valid data and was understood by the server, but the server
23
+ * is refusing action.
24
+ */
25
+ export declare const Forbidden: CloseEvent;
26
+ /**
27
+ * The server timed out waiting for the request.
28
+ */
29
+ export declare const ConnectionTimeout: CloseEvent;
@@ -1,6 +1,6 @@
1
- import * as encoding from 'lib0/encoding';
2
- import * as decoding from 'lib0/decoding';
3
- export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
4
- export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
5
- export declare const writeAuthenticated: (encoder: encoding.Encoder) => void;
6
- export declare const readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: () => void) => void;
1
+ import * as encoding from 'lib0/encoding';
2
+ import * as decoding from 'lib0/decoding';
3
+ export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
4
+ export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
5
+ export declare const writeAuthenticated: (encoder: encoding.Encoder, scope: 'readonly' | 'read-write') => void;
6
+ export declare const readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;
@@ -1,3 +1,3 @@
1
- export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
2
- clientId: number;
3
- }[];
1
+ export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
2
+ clientId: number;
3
+ }[];
@@ -1,4 +1,4 @@
1
- export * from './auth';
2
- export * from './CloseEvents';
3
- export * from './awarenessStatesToArray';
4
- export * from './types';
1
+ export * from './auth.js';
2
+ export * from './CloseEvents.js';
3
+ export * from './awarenessStatesToArray.js';
4
+ export * from './types.js';
@@ -1,10 +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
+ /**
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,30 +1,30 @@
1
- import { Extension, onChangePayload, onLoadDocumentPayload, storePayload, fetchPayload } from '@hocuspocus/server';
2
- export interface DatabaseConfiguration {
3
- /**
4
- * Pass a Promise to retrieve updates from your database. The Promise should resolve to
5
- * an array of items with Y.js-compatible binary data.
6
- */
7
- fetch: (data: fetchPayload) => Promise<Uint8Array | null>;
8
- /**
9
- * Pass a function to store updates in your database.
10
- */
11
- store: (data: storePayload) => void;
12
- }
13
- export declare class Database implements Extension {
14
- /**
15
- * Default configuration
16
- */
17
- configuration: DatabaseConfiguration;
18
- /**
19
- * Constructor
20
- */
21
- constructor(configuration: Partial<DatabaseConfiguration>);
22
- /**
23
- * Get stored data from the database.
24
- */
25
- onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
26
- /**
27
- * Store new updates in the database.
28
- */
29
- onStoreDocument(data: onChangePayload): Promise<void>;
30
- }
1
+ import { Extension, onChangePayload, onLoadDocumentPayload, storePayload, fetchPayload } from '@hocuspocus/server';
2
+ export interface DatabaseConfiguration {
3
+ /**
4
+ * Pass a Promise to retrieve updates from your database. The Promise should resolve to
5
+ * an array of items with Y.js-compatible binary data.
6
+ */
7
+ fetch: (data: fetchPayload) => Promise<Uint8Array | null>;
8
+ /**
9
+ * Pass a function to store updates in your database.
10
+ */
11
+ store: (data: storePayload) => void;
12
+ }
13
+ export declare class Database implements Extension {
14
+ /**
15
+ * Default configuration
16
+ */
17
+ configuration: DatabaseConfiguration;
18
+ /**
19
+ * Constructor
20
+ */
21
+ constructor(configuration: Partial<DatabaseConfiguration>);
22
+ /**
23
+ * Get stored data from the database.
24
+ */
25
+ onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
26
+ /**
27
+ * Store new updates in the database.
28
+ */
29
+ onStoreDocument(data: onChangePayload): Promise<void>;
30
+ }
@@ -1 +1 @@
1
- export * from './Database';
1
+ export * from './Database.js';
@@ -1,67 +1,67 @@
1
- import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
2
- export interface LoggerConfiguration {
3
- /**
4
- * Prepend all logging message with a string.
5
- *
6
- * @deprecated
7
- */
8
- prefix: null | string;
9
- /**
10
- * Whether to log something for the `onLoadDocument` hook.
11
- */
12
- onLoadDocument: boolean;
13
- /**
14
- * Whether to log something for the `onChange` hook.
15
- */
16
- onChange: boolean;
17
- /**
18
- * Whether to log something for the `onStoreDocument` hook.
19
- */
20
- onStoreDocument: boolean;
21
- /**
22
- * Whether to log something for the `onConnect` hook.
23
- */
24
- onConnect: boolean;
25
- /**
26
- * Whether to log something for the `onDisconnect` hook.
27
- */
28
- onDisconnect: boolean;
29
- /**
30
- * Whether to log something for the `onUpgrade` hook.
31
- */
32
- onUpgrade: boolean;
33
- /**
34
- * Whether to log something for the `onRequest` hook.
35
- */
36
- onRequest: boolean;
37
- /**
38
- * Whether to log something for the `onDestroy` hook.
39
- */
40
- onDestroy: boolean;
41
- /**
42
- * Whether to log something for the `onConfigure` hook.
43
- */
44
- onConfigure: boolean;
45
- /**
46
- * A log function, if none is provided output will go to console
47
- */
48
- log: (...args: any[]) => void;
49
- }
50
- export declare class Logger implements Extension {
51
- name: string | null;
52
- configuration: LoggerConfiguration;
53
- /**
54
- * Constructor
55
- */
56
- constructor(configuration?: Partial<LoggerConfiguration>);
57
- onConfigure(data: onConfigurePayload): Promise<void>;
58
- onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
59
- onChange(data: onChangePayload): Promise<void>;
60
- onStoreDocument(data: onDisconnectPayload): Promise<void>;
61
- onConnect(data: onConnectPayload): Promise<void>;
62
- onDisconnect(data: onDisconnectPayload): Promise<void>;
63
- onUpgrade(data: onUpgradePayload): Promise<void>;
64
- onRequest(data: onRequestPayload): Promise<void>;
65
- onDestroy(data: onDestroyPayload): Promise<void>;
66
- private log;
67
- }
1
+ import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
2
+ export interface LoggerConfiguration {
3
+ /**
4
+ * Prepend all logging message with a string.
5
+ *
6
+ * @deprecated
7
+ */
8
+ prefix: null | string;
9
+ /**
10
+ * Whether to log something for the `onLoadDocument` hook.
11
+ */
12
+ onLoadDocument: boolean;
13
+ /**
14
+ * Whether to log something for the `onChange` hook.
15
+ */
16
+ onChange: boolean;
17
+ /**
18
+ * Whether to log something for the `onStoreDocument` hook.
19
+ */
20
+ onStoreDocument: boolean;
21
+ /**
22
+ * Whether to log something for the `onConnect` hook.
23
+ */
24
+ onConnect: boolean;
25
+ /**
26
+ * Whether to log something for the `onDisconnect` hook.
27
+ */
28
+ onDisconnect: boolean;
29
+ /**
30
+ * Whether to log something for the `onUpgrade` hook.
31
+ */
32
+ onUpgrade: boolean;
33
+ /**
34
+ * Whether to log something for the `onRequest` hook.
35
+ */
36
+ onRequest: boolean;
37
+ /**
38
+ * Whether to log something for the `onDestroy` hook.
39
+ */
40
+ onDestroy: boolean;
41
+ /**
42
+ * Whether to log something for the `onConfigure` hook.
43
+ */
44
+ onConfigure: boolean;
45
+ /**
46
+ * A log function, if none is provided output will go to console
47
+ */
48
+ log: (...args: any[]) => void;
49
+ }
50
+ export declare class Logger implements Extension {
51
+ name: string | null;
52
+ configuration: LoggerConfiguration;
53
+ /**
54
+ * Constructor
55
+ */
56
+ constructor(configuration?: Partial<LoggerConfiguration>);
57
+ onConfigure(data: onConfigurePayload): Promise<void>;
58
+ onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
59
+ onChange(data: onChangePayload): Promise<void>;
60
+ onStoreDocument(data: onDisconnectPayload): Promise<void>;
61
+ onConnect(data: onConnectPayload): Promise<void>;
62
+ onDisconnect(data: onDisconnectPayload): Promise<void>;
63
+ onUpgrade(data: onUpgradePayload): Promise<void>;
64
+ onRequest(data: onRequestPayload): Promise<void>;
65
+ onDestroy(data: onDestroyPayload): Promise<void>;
66
+ private log;
67
+ }
@@ -1 +1 @@
1
- export * from './Logger';
1
+ export * from './Logger.js';