@hocuspocus/extension-logger 3.4.3 → 3.4.5-rc.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 (142) hide show
  1. package/dist/hocuspocus-logger.cjs +64 -85
  2. package/dist/hocuspocus-logger.cjs.map +1 -1
  3. package/dist/hocuspocus-logger.esm.js +63 -84
  4. package/dist/hocuspocus-logger.esm.js.map +1 -1
  5. package/dist/index.d.ts +71 -0
  6. package/dist/index.js +64 -0
  7. package/package.json +4 -4
  8. package/dist/node_modules/@tiptap/pm/model/index.d.ts +0 -1
  9. package/dist/node_modules/@tiptap/pm/state/index.d.ts +0 -1
  10. package/dist/node_modules/@tiptap/pm/transform/index.d.ts +0 -1
  11. package/dist/node_modules/@tiptap/pm/view/index.d.ts +0 -1
  12. package/dist/packages/common/src/CloseEvents.d.ts +0 -29
  13. package/dist/packages/common/src/auth.d.ts +0 -12
  14. package/dist/packages/common/src/awarenessStatesToArray.d.ts +0 -3
  15. package/dist/packages/common/src/index.d.ts +0 -4
  16. package/dist/packages/common/src/types.d.ts +0 -10
  17. package/dist/packages/extension-database/src/Database.d.ts +0 -30
  18. package/dist/packages/extension-database/src/index.d.ts +0 -1
  19. package/dist/packages/extension-logger/src/Logger.d.ts +0 -67
  20. package/dist/packages/extension-logger/src/index.d.ts +0 -1
  21. package/dist/packages/extension-redis/src/Redis.d.ts +0 -124
  22. package/dist/packages/extension-redis/src/index.d.ts +0 -1
  23. package/dist/packages/extension-s3/src/S3.d.ts +0 -44
  24. package/dist/packages/extension-s3/src/index.d.ts +0 -1
  25. package/dist/packages/extension-sqlite/src/SQLite.d.ts +0 -27
  26. package/dist/packages/extension-sqlite/src/index.d.ts +0 -1
  27. package/dist/packages/extension-throttle/src/index.d.ts +0 -30
  28. package/dist/packages/extension-webhook/src/index.d.ts +0 -56
  29. package/dist/packages/provider/src/EventEmitter.d.ts +0 -9
  30. package/dist/packages/provider/src/HocuspocusProvider.d.ts +0 -116
  31. package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts +0 -114
  32. package/dist/packages/provider/src/IncomingMessage.d.ts +0 -17
  33. package/dist/packages/provider/src/MessageReceiver.d.ts +0 -12
  34. package/dist/packages/provider/src/MessageSender.d.ts +0 -9
  35. package/dist/packages/provider/src/OutgoingMessage.d.ts +0 -9
  36. package/dist/packages/provider/src/OutgoingMessages/AuthenticationMessage.d.ts +0 -8
  37. package/dist/packages/provider/src/OutgoingMessages/AwarenessMessage.d.ts +0 -9
  38. package/dist/packages/provider/src/OutgoingMessages/CloseMessage.d.ts +0 -9
  39. package/dist/packages/provider/src/OutgoingMessages/QueryAwarenessMessage.d.ts +0 -9
  40. package/dist/packages/provider/src/OutgoingMessages/StatelessMessage.d.ts +0 -8
  41. package/dist/packages/provider/src/OutgoingMessages/SyncStepOneMessage.d.ts +0 -9
  42. package/dist/packages/provider/src/OutgoingMessages/SyncStepTwoMessage.d.ts +0 -9
  43. package/dist/packages/provider/src/OutgoingMessages/UpdateMessage.d.ts +0 -8
  44. package/dist/packages/provider/src/index.d.ts +0 -3
  45. package/dist/packages/provider/src/types.d.ts +0 -92
  46. package/dist/packages/server/src/ClientConnection.d.ts +0 -63
  47. package/dist/packages/server/src/Connection.d.ts +0 -71
  48. package/dist/packages/server/src/DirectConnection.d.ts +0 -14
  49. package/dist/packages/server/src/Document.d.ts +0 -92
  50. package/dist/packages/server/src/Hocuspocus.d.ts +0 -80
  51. package/dist/packages/server/src/IncomingMessage.d.ts +0 -25
  52. package/dist/packages/server/src/MessageReceiver.d.ts +0 -11
  53. package/dist/packages/server/src/OutgoingMessage.d.ts +0 -23
  54. package/dist/packages/server/src/Server.d.ts +0 -32
  55. package/dist/packages/server/src/index.d.ts +0 -9
  56. package/dist/packages/server/src/types.d.ts +0 -342
  57. package/dist/packages/server/src/util/debounce.d.ts +0 -6
  58. package/dist/packages/server/src/util/getParameters.d.ts +0 -6
  59. package/dist/packages/transformer/src/Prosemirror.d.ts +0 -11
  60. package/dist/packages/transformer/src/Tiptap.d.ts +0 -10
  61. package/dist/packages/transformer/src/index.d.ts +0 -3
  62. package/dist/packages/transformer/src/types.d.ts +0 -5
  63. package/dist/playground/backend/src/default.d.ts +0 -1
  64. package/dist/playground/backend/src/deno.d.ts +0 -1
  65. package/dist/playground/backend/src/express.d.ts +0 -1
  66. package/dist/playground/backend/src/hono.d.ts +0 -1
  67. package/dist/playground/backend/src/koa.d.ts +0 -1
  68. package/dist/playground/backend/src/load-document.d.ts +0 -1
  69. package/dist/playground/backend/src/redis.d.ts +0 -1
  70. package/dist/playground/backend/src/s3-redis.d.ts +0 -1
  71. package/dist/playground/backend/src/s3.d.ts +0 -1
  72. package/dist/playground/backend/src/slow.d.ts +0 -1
  73. package/dist/playground/backend/src/tiptapcollab.d.ts +0 -1
  74. package/dist/playground/backend/src/webhook.d.ts +0 -1
  75. package/dist/playground/frontend/app/SocketContext1.d.ts +0 -2
  76. package/dist/playground/frontend/app/SocketContext2.d.ts +0 -2
  77. package/dist/playground/frontend/next.config.d.ts +0 -3
  78. package/dist/tests/extension-database/fetch.d.ts +0 -1
  79. package/dist/tests/extension-logger/onListen.d.ts +0 -1
  80. package/dist/tests/extension-redis/onAwarenessChange.d.ts +0 -1
  81. package/dist/tests/extension-redis/onChange.d.ts +0 -1
  82. package/dist/tests/extension-redis/onStateless.d.ts +0 -1
  83. package/dist/tests/extension-redis/onStoreDocument.d.ts +0 -1
  84. package/dist/tests/extension-s3/fetch.d.ts +0 -1
  85. package/dist/tests/extension-throttle/banning.d.ts +0 -1
  86. package/dist/tests/extension-throttle/configuration.d.ts +0 -1
  87. package/dist/tests/provider/hasUnsyncedChanges.d.ts +0 -1
  88. package/dist/tests/provider/observe.d.ts +0 -1
  89. package/dist/tests/provider/observeDeep.d.ts +0 -1
  90. package/dist/tests/provider/onAuthenticated.d.ts +0 -1
  91. package/dist/tests/provider/onAuthenticationFailed.d.ts +0 -1
  92. package/dist/tests/provider/onAwarenessChange.d.ts +0 -1
  93. package/dist/tests/provider/onAwarenessUpdate.d.ts +0 -1
  94. package/dist/tests/provider/onClose.d.ts +0 -1
  95. package/dist/tests/provider/onConnect.d.ts +0 -1
  96. package/dist/tests/provider/onDisconnect.d.ts +0 -1
  97. package/dist/tests/provider/onMessage.d.ts +0 -1
  98. package/dist/tests/provider/onOpen.d.ts +0 -1
  99. package/dist/tests/provider/onStateless.d.ts +0 -1
  100. package/dist/tests/provider/onSynced.d.ts +0 -1
  101. package/dist/tests/providerwebsocket/configuration.d.ts +0 -1
  102. package/dist/tests/server/address.d.ts +0 -1
  103. package/dist/tests/server/afterLoadDocument.d.ts +0 -1
  104. package/dist/tests/server/afterStoreDocument.d.ts +0 -1
  105. package/dist/tests/server/afterUnloadDocument.d.ts +0 -1
  106. package/dist/tests/server/beforeBroadcastStateless.d.ts +0 -1
  107. package/dist/tests/server/beforeHandleMessage.d.ts +0 -1
  108. package/dist/tests/server/beforeSync.d.ts +0 -1
  109. package/dist/tests/server/beforeUnloadDocument.d.ts +0 -1
  110. package/dist/tests/server/closeConnections.d.ts +0 -1
  111. package/dist/tests/server/getConnectionsCount.d.ts +0 -1
  112. package/dist/tests/server/getDocumentsCount.d.ts +0 -1
  113. package/dist/tests/server/listen.d.ts +0 -1
  114. package/dist/tests/server/onAuthenticate.d.ts +0 -1
  115. package/dist/tests/server/onAwarenessUpdate.d.ts +0 -1
  116. package/dist/tests/server/onChange.d.ts +0 -1
  117. package/dist/tests/server/onClose.d.ts +0 -1
  118. package/dist/tests/server/onConfigure.d.ts +0 -1
  119. package/dist/tests/server/onConnect.d.ts +0 -1
  120. package/dist/tests/server/onDestroy.d.ts +0 -1
  121. package/dist/tests/server/onDisconnect.d.ts +0 -1
  122. package/dist/tests/server/onListen.d.ts +0 -1
  123. package/dist/tests/server/onLoadDocument.d.ts +0 -1
  124. package/dist/tests/server/onRequest.d.ts +0 -1
  125. package/dist/tests/server/onStateless.d.ts +0 -1
  126. package/dist/tests/server/onStoreDocument.d.ts +0 -1
  127. package/dist/tests/server/onTokenSync.d.ts +0 -1
  128. package/dist/tests/server/onUpgrade.d.ts +0 -1
  129. package/dist/tests/server/openDirectConnection.d.ts +0 -1
  130. package/dist/tests/server/websocketError.d.ts +0 -1
  131. package/dist/tests/transformer/TiptapTransformer.d.ts +0 -1
  132. package/dist/tests/utils/createDirectory.d.ts +0 -1
  133. package/dist/tests/utils/flushRedis.d.ts +0 -1
  134. package/dist/tests/utils/index.d.ts +0 -9
  135. package/dist/tests/utils/newHocuspocus.d.ts +0 -2
  136. package/dist/tests/utils/newHocuspocusProvider.d.ts +0 -3
  137. package/dist/tests/utils/newHocuspocusProviderWebsocket.d.ts +0 -4
  138. package/dist/tests/utils/randomInteger.d.ts +0 -1
  139. package/dist/tests/utils/redisConnectionSettings.d.ts +0 -4
  140. package/dist/tests/utils/removeDirectory.d.ts +0 -1
  141. package/dist/tests/utils/retryableAssertion.d.ts +0 -2
  142. package/dist/tests/utils/sleep.d.ts +0 -1
@@ -1,88 +1,67 @@
1
- 'use strict';
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
2
 
3
- class Logger {
4
- /**
5
- * Constructor
6
- */
7
- constructor(configuration) {
8
- this.name = null;
9
- this.configuration = {
10
- prefix: null,
11
- onLoadDocument: true,
12
- onChange: true,
13
- onStoreDocument: true,
14
- onConnect: true,
15
- onDisconnect: true,
16
- onUpgrade: true,
17
- onRequest: true,
18
- onDestroy: true,
19
- onConfigure: true,
20
- log: console.log, // eslint-disable-line
21
- };
22
- this.configuration = {
23
- ...this.configuration,
24
- ...configuration,
25
- };
26
- }
27
- async onConfigure(data) {
28
- this.name = data.instance.configuration.name;
29
- if (!this.configuration.onConfigure) {
30
- return;
31
- }
32
- if (this.configuration.prefix) {
33
- console.warn("[hocuspocus warn] The Logger 'prefix' is deprecated. Pass a 'name' to the Hocuspocus configuration instead.");
34
- }
35
- }
36
- async onLoadDocument(data) {
37
- if (this.configuration.onLoadDocument) {
38
- this.log(`Loaded document "${data.documentName}".`);
39
- }
40
- }
41
- async onChange(data) {
42
- if (this.configuration.onChange) {
43
- this.log(`Document "${data.documentName}" changed.`);
44
- }
45
- }
46
- async onStoreDocument(data) {
47
- if (this.configuration.onStoreDocument) {
48
- this.log(`Store "${data.documentName}".`);
49
- }
50
- }
51
- async onConnect(data) {
52
- if (this.configuration.onConnect) {
53
- this.log(`New connection to "${data.documentName}".`);
54
- }
55
- }
56
- async onDisconnect(data) {
57
- if (this.configuration.onDisconnect) {
58
- this.log(`Connection to "${data.documentName}" closed.`);
59
- }
60
- }
61
- async onUpgrade(data) {
62
- if (this.configuration.onUpgrade) {
63
- this.log("Upgrading connection …");
64
- }
65
- }
66
- async onRequest(data) {
67
- if (this.configuration.onRequest) {
68
- this.log(`Incoming HTTP Request to ${data.request.url}`);
69
- }
70
- }
71
- async onDestroy(data) {
72
- if (this.configuration.onDestroy) {
73
- this.log("Shut down.");
74
- }
75
- }
76
- log(message) {
77
- const date = new Date().toISOString();
78
- let meta = `${date}`;
79
- if (this.name) {
80
- meta = `${this.name} ${meta}`;
81
- }
82
- message = `[${meta}] ${message}`;
83
- this.configuration.log(message);
84
- }
85
- }
3
+ //#region packages/extension-logger/src/Logger.ts
4
+ var Logger = class {
5
+ /**
6
+ * Constructor
7
+ */
8
+ constructor(configuration) {
9
+ this.name = null;
10
+ this.configuration = {
11
+ prefix: null,
12
+ onLoadDocument: true,
13
+ onChange: true,
14
+ onStoreDocument: true,
15
+ onConnect: true,
16
+ onDisconnect: true,
17
+ onUpgrade: true,
18
+ onRequest: true,
19
+ onDestroy: true,
20
+ onConfigure: true,
21
+ log: console.log
22
+ };
23
+ this.configuration = {
24
+ ...this.configuration,
25
+ ...configuration
26
+ };
27
+ }
28
+ async onConfigure(data) {
29
+ this.name = data.instance.configuration.name;
30
+ if (!this.configuration.onConfigure) return;
31
+ if (this.configuration.prefix) console.warn("[hocuspocus warn] The Logger 'prefix' is deprecated. Pass a 'name' to the Hocuspocus configuration instead.");
32
+ }
33
+ async onLoadDocument(data) {
34
+ if (this.configuration.onLoadDocument) this.log(`Loaded document "${data.documentName}".`);
35
+ }
36
+ async onChange(data) {
37
+ if (this.configuration.onChange) this.log(`Document "${data.documentName}" changed.`);
38
+ }
39
+ async onStoreDocument(data) {
40
+ if (this.configuration.onStoreDocument) this.log(`Store "${data.documentName}".`);
41
+ }
42
+ async onConnect(data) {
43
+ if (this.configuration.onConnect) this.log(`New connection to "${data.documentName}".`);
44
+ }
45
+ async onDisconnect(data) {
46
+ if (this.configuration.onDisconnect) this.log(`Connection to "${data.documentName}" closed.`);
47
+ }
48
+ async onUpgrade(data) {
49
+ if (this.configuration.onUpgrade) this.log("Upgrading connection …");
50
+ }
51
+ async onRequest(data) {
52
+ if (this.configuration.onRequest) this.log(`Incoming HTTP Request to ${data.request.url}`);
53
+ }
54
+ async onDestroy(data) {
55
+ if (this.configuration.onDestroy) this.log("Shut down.");
56
+ }
57
+ log(message) {
58
+ let meta = `${(/* @__PURE__ */ new Date()).toISOString()}`;
59
+ if (this.name) meta = `${this.name} ${meta}`;
60
+ message = `[${meta}] ${message}`;
61
+ this.configuration.log(message);
62
+ }
63
+ };
86
64
 
65
+ //#endregion
87
66
  exports.Logger = Logger;
88
- //# sourceMappingURL=hocuspocus-logger.cjs.map
67
+ //# sourceMappingURL=hocuspocus-logger.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"hocuspocus-logger.cjs","sources":["../src/Logger.ts"],"sourcesContent":[null],"names":[],"mappings":";;MA6Da,MAAM,CAAA;AAiBlB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA4C,EAAA;QAnBxD,IAAI,CAAA,IAAA,GAAkB,IAAI;AAE1B,QAAA,IAAA,CAAA,aAAa,GAAwB;AACpC,YAAA,MAAM,EAAE,IAAI;AACZ,YAAA,cAAc,EAAE,IAAI;AACpB,YAAA,QAAQ,EAAE,IAAI;AACd,YAAA,eAAe,EAAE,IAAI;AACrB,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,YAAY,EAAE,IAAI;AAClB,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,GAAG,EAAE,OAAO,CAAC,GAAG;SAChB;QAMA,IAAI,CAAC,aAAa,GAAG;YACpB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SAChB;;IAGF,MAAM,WAAW,CAAC,IAAwB,EAAA;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI;AAE5C,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;YACpC;;AAGD,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;AAC9B,YAAA,OAAO,CAAC,IAAI,CACX,6GAA6G,CAC7G;;;IAIH,MAAM,cAAc,CAAC,IAA2B,EAAA;AAC/C,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YACtC,IAAI,CAAC,GAAG,CAAC,CAAA,iBAAA,EAAoB,IAAI,CAAC,YAAY,CAAI,EAAA,CAAA,CAAC;;;IAIrD,MAAM,QAAQ,CAAC,IAAqB,EAAA;AACnC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,CAAA,UAAA,EAAa,IAAI,CAAC,YAAY,CAAY,UAAA,CAAA,CAAC;;;IAItD,MAAM,eAAe,CAAC,IAAyB,EAAA;AAC9C,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE;YACvC,IAAI,CAAC,GAAG,CAAC,CAAA,OAAA,EAAU,IAAI,CAAC,YAAY,CAAI,EAAA,CAAA,CAAC;;;IAI3C,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YACjC,IAAI,CAAC,GAAG,CAAC,CAAA,mBAAA,EAAsB,IAAI,CAAC,YAAY,CAAI,EAAA,CAAA,CAAC;;;IAIvD,MAAM,YAAY,CAAC,IAAyB,EAAA;AAC3C,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,CAAA,eAAA,EAAkB,IAAI,CAAC,YAAY,CAAW,SAAA,CAAA,CAAC;;;IAI1D,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;AACjC,YAAA,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC;;;IAIpC,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YACjC,IAAI,CAAC,GAAG,CAAC,CAA4B,yBAAA,EAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAE,CAAA,CAAC;;;IAI1D,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;AACjC,YAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC;;;AAIhB,IAAA,GAAG,CAAC,OAAe,EAAA;QAC1B,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;AACrC,QAAA,IAAI,IAAI,GAAG,CAAG,EAAA,IAAI,EAAE;AAEpB,QAAA,IAAI,IAAI,CAAC,IAAI,EAAE;YACd,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,CAAI,CAAA,EAAA,IAAI,EAAE;;AAG9B,QAAA,OAAO,GAAG,CAAI,CAAA,EAAA,IAAI,CAAK,EAAA,EAAA,OAAO,EAAE;AAEhC,QAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC;;AAEhC;;;;"}
1
+ {"version":3,"file":"hocuspocus-logger.cjs","names":[],"sources":["../src/Logger.ts"],"sourcesContent":["import type {\n\tExtension,\n\tonChangePayload,\n\tonConfigurePayload,\n\tonConnectPayload,\n\tonLoadDocumentPayload,\n\tonDestroyPayload,\n\tonDisconnectPayload,\n\tonRequestPayload,\n\tonUpgradePayload,\n} from \"@hocuspocus/server\";\n\nexport interface LoggerConfiguration {\n\t/**\n\t * Prepend all logging message with a string.\n\t *\n\t * @deprecated\n\t */\n\tprefix: null | string;\n\t/**\n\t * Whether to log something for the `onLoadDocument` hook.\n\t */\n\tonLoadDocument: boolean;\n\t/**\n\t * Whether to log something for the `onChange` hook.\n\t */\n\tonChange: boolean;\n\t/**\n\t * Whether to log something for the `onStoreDocument` hook.\n\t */\n\tonStoreDocument: boolean;\n\t/**\n\t * Whether to log something for the `onConnect` hook.\n\t */\n\tonConnect: boolean;\n\t/**\n\t * Whether to log something for the `onDisconnect` hook.\n\t */\n\tonDisconnect: boolean;\n\t/**\n\t * Whether to log something for the `onUpgrade` hook.\n\t */\n\tonUpgrade: boolean;\n\t/**\n\t * Whether to log something for the `onRequest` hook.\n\t */\n\tonRequest: boolean;\n\t/**\n\t * Whether to log something for the `onDestroy` hook.\n\t */\n\tonDestroy: boolean;\n\t/**\n\t * Whether to log something for the `onConfigure` hook.\n\t */\n\tonConfigure: boolean;\n\t/**\n\t * A log function, if none is provided output will go to console\n\t */\n\tlog: (...args: any[]) => void;\n}\n\nexport class Logger implements Extension {\n\tname: string | null = null;\n\n\tconfiguration: LoggerConfiguration = {\n\t\tprefix: null,\n\t\tonLoadDocument: true,\n\t\tonChange: true,\n\t\tonStoreDocument: true,\n\t\tonConnect: true,\n\t\tonDisconnect: true,\n\t\tonUpgrade: true,\n\t\tonRequest: true,\n\t\tonDestroy: true,\n\t\tonConfigure: true,\n\t\tlog: console.log, // eslint-disable-line\n\t};\n\n\t/**\n\t * Constructor\n\t */\n\tconstructor(configuration?: Partial<LoggerConfiguration>) {\n\t\tthis.configuration = {\n\t\t\t...this.configuration,\n\t\t\t...configuration,\n\t\t};\n\t}\n\n\tasync onConfigure(data: onConfigurePayload) {\n\t\tthis.name = data.instance.configuration.name;\n\n\t\tif (!this.configuration.onConfigure) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (this.configuration.prefix) {\n\t\t\tconsole.warn(\n\t\t\t\t\"[hocuspocus warn] The Logger 'prefix' is deprecated. Pass a 'name' to the Hocuspocus configuration instead.\",\n\t\t\t);\n\t\t}\n\t}\n\n\tasync onLoadDocument(data: onLoadDocumentPayload) {\n\t\tif (this.configuration.onLoadDocument) {\n\t\t\tthis.log(`Loaded document \"${data.documentName}\".`);\n\t\t}\n\t}\n\n\tasync onChange(data: onChangePayload) {\n\t\tif (this.configuration.onChange) {\n\t\t\tthis.log(`Document \"${data.documentName}\" changed.`);\n\t\t}\n\t}\n\n\tasync onStoreDocument(data: onDisconnectPayload) {\n\t\tif (this.configuration.onStoreDocument) {\n\t\t\tthis.log(`Store \"${data.documentName}\".`);\n\t\t}\n\t}\n\n\tasync onConnect(data: onConnectPayload) {\n\t\tif (this.configuration.onConnect) {\n\t\t\tthis.log(`New connection to \"${data.documentName}\".`);\n\t\t}\n\t}\n\n\tasync onDisconnect(data: onDisconnectPayload) {\n\t\tif (this.configuration.onDisconnect) {\n\t\t\tthis.log(`Connection to \"${data.documentName}\" closed.`);\n\t\t}\n\t}\n\n\tasync onUpgrade(data: onUpgradePayload) {\n\t\tif (this.configuration.onUpgrade) {\n\t\t\tthis.log(\"Upgrading connection …\");\n\t\t}\n\t}\n\n\tasync onRequest(data: onRequestPayload) {\n\t\tif (this.configuration.onRequest) {\n\t\t\tthis.log(`Incoming HTTP Request to ${data.request.url}`);\n\t\t}\n\t}\n\n\tasync onDestroy(data: onDestroyPayload) {\n\t\tif (this.configuration.onDestroy) {\n\t\t\tthis.log(\"Shut down.\");\n\t\t}\n\t}\n\n\tprivate log(message: string) {\n\t\tconst date = new Date().toISOString();\n\t\tlet meta = `${date}`;\n\n\t\tif (this.name) {\n\t\t\tmeta = `${this.name} ${meta}`;\n\t\t}\n\n\t\tmessage = `[${meta}] ${message}`;\n\n\t\tthis.configuration.log(message);\n\t}\n}\n"],"mappings":";;;AA6DA,IAAa,SAAb,MAAyC;;;;CAoBxC,YAAY,eAA8C;cAnBpC;uBAEe;GACpC,QAAQ;GACR,gBAAgB;GAChB,UAAU;GACV,iBAAiB;GACjB,WAAW;GACX,cAAc;GACd,WAAW;GACX,WAAW;GACX,WAAW;GACX,aAAa;GACb,KAAK,QAAQ;GACb;AAMA,OAAK,gBAAgB;GACpB,GAAG,KAAK;GACR,GAAG;GACH;;CAGF,MAAM,YAAY,MAA0B;AAC3C,OAAK,OAAO,KAAK,SAAS,cAAc;AAExC,MAAI,CAAC,KAAK,cAAc,YACvB;AAGD,MAAI,KAAK,cAAc,OACtB,SAAQ,KACP,8GACA;;CAIH,MAAM,eAAe,MAA6B;AACjD,MAAI,KAAK,cAAc,eACtB,MAAK,IAAI,oBAAoB,KAAK,aAAa,IAAI;;CAIrD,MAAM,SAAS,MAAuB;AACrC,MAAI,KAAK,cAAc,SACtB,MAAK,IAAI,aAAa,KAAK,aAAa,YAAY;;CAItD,MAAM,gBAAgB,MAA2B;AAChD,MAAI,KAAK,cAAc,gBACtB,MAAK,IAAI,UAAU,KAAK,aAAa,IAAI;;CAI3C,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,sBAAsB,KAAK,aAAa,IAAI;;CAIvD,MAAM,aAAa,MAA2B;AAC7C,MAAI,KAAK,cAAc,aACtB,MAAK,IAAI,kBAAkB,KAAK,aAAa,WAAW;;CAI1D,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,yBAAyB;;CAIpC,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,4BAA4B,KAAK,QAAQ,MAAM;;CAI1D,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,aAAa;;CAIxB,AAAQ,IAAI,SAAiB;EAE5B,IAAI,OAAO,oBADE,IAAI,MAAM,EAAC,aAAa;AAGrC,MAAI,KAAK,KACR,QAAO,GAAG,KAAK,KAAK,GAAG;AAGxB,YAAU,IAAI,KAAK,IAAI;AAEvB,OAAK,cAAc,IAAI,QAAQ"}
@@ -1,86 +1,65 @@
1
- class Logger {
2
- /**
3
- * Constructor
4
- */
5
- constructor(configuration) {
6
- this.name = null;
7
- this.configuration = {
8
- prefix: null,
9
- onLoadDocument: true,
10
- onChange: true,
11
- onStoreDocument: true,
12
- onConnect: true,
13
- onDisconnect: true,
14
- onUpgrade: true,
15
- onRequest: true,
16
- onDestroy: true,
17
- onConfigure: true,
18
- log: console.log, // eslint-disable-line
19
- };
20
- this.configuration = {
21
- ...this.configuration,
22
- ...configuration,
23
- };
24
- }
25
- async onConfigure(data) {
26
- this.name = data.instance.configuration.name;
27
- if (!this.configuration.onConfigure) {
28
- return;
29
- }
30
- if (this.configuration.prefix) {
31
- console.warn("[hocuspocus warn] The Logger 'prefix' is deprecated. Pass a 'name' to the Hocuspocus configuration instead.");
32
- }
33
- }
34
- async onLoadDocument(data) {
35
- if (this.configuration.onLoadDocument) {
36
- this.log(`Loaded document "${data.documentName}".`);
37
- }
38
- }
39
- async onChange(data) {
40
- if (this.configuration.onChange) {
41
- this.log(`Document "${data.documentName}" changed.`);
42
- }
43
- }
44
- async onStoreDocument(data) {
45
- if (this.configuration.onStoreDocument) {
46
- this.log(`Store "${data.documentName}".`);
47
- }
48
- }
49
- async onConnect(data) {
50
- if (this.configuration.onConnect) {
51
- this.log(`New connection to "${data.documentName}".`);
52
- }
53
- }
54
- async onDisconnect(data) {
55
- if (this.configuration.onDisconnect) {
56
- this.log(`Connection to "${data.documentName}" closed.`);
57
- }
58
- }
59
- async onUpgrade(data) {
60
- if (this.configuration.onUpgrade) {
61
- this.log("Upgrading connection …");
62
- }
63
- }
64
- async onRequest(data) {
65
- if (this.configuration.onRequest) {
66
- this.log(`Incoming HTTP Request to ${data.request.url}`);
67
- }
68
- }
69
- async onDestroy(data) {
70
- if (this.configuration.onDestroy) {
71
- this.log("Shut down.");
72
- }
73
- }
74
- log(message) {
75
- const date = new Date().toISOString();
76
- let meta = `${date}`;
77
- if (this.name) {
78
- meta = `${this.name} ${meta}`;
79
- }
80
- message = `[${meta}] ${message}`;
81
- this.configuration.log(message);
82
- }
83
- }
1
+ //#region packages/extension-logger/src/Logger.ts
2
+ var Logger = class {
3
+ /**
4
+ * Constructor
5
+ */
6
+ constructor(configuration) {
7
+ this.name = null;
8
+ this.configuration = {
9
+ prefix: null,
10
+ onLoadDocument: true,
11
+ onChange: true,
12
+ onStoreDocument: true,
13
+ onConnect: true,
14
+ onDisconnect: true,
15
+ onUpgrade: true,
16
+ onRequest: true,
17
+ onDestroy: true,
18
+ onConfigure: true,
19
+ log: console.log
20
+ };
21
+ this.configuration = {
22
+ ...this.configuration,
23
+ ...configuration
24
+ };
25
+ }
26
+ async onConfigure(data) {
27
+ this.name = data.instance.configuration.name;
28
+ if (!this.configuration.onConfigure) return;
29
+ if (this.configuration.prefix) console.warn("[hocuspocus warn] The Logger 'prefix' is deprecated. Pass a 'name' to the Hocuspocus configuration instead.");
30
+ }
31
+ async onLoadDocument(data) {
32
+ if (this.configuration.onLoadDocument) this.log(`Loaded document "${data.documentName}".`);
33
+ }
34
+ async onChange(data) {
35
+ if (this.configuration.onChange) this.log(`Document "${data.documentName}" changed.`);
36
+ }
37
+ async onStoreDocument(data) {
38
+ if (this.configuration.onStoreDocument) this.log(`Store "${data.documentName}".`);
39
+ }
40
+ async onConnect(data) {
41
+ if (this.configuration.onConnect) this.log(`New connection to "${data.documentName}".`);
42
+ }
43
+ async onDisconnect(data) {
44
+ if (this.configuration.onDisconnect) this.log(`Connection to "${data.documentName}" closed.`);
45
+ }
46
+ async onUpgrade(data) {
47
+ if (this.configuration.onUpgrade) this.log("Upgrading connection …");
48
+ }
49
+ async onRequest(data) {
50
+ if (this.configuration.onRequest) this.log(`Incoming HTTP Request to ${data.request.url}`);
51
+ }
52
+ async onDestroy(data) {
53
+ if (this.configuration.onDestroy) this.log("Shut down.");
54
+ }
55
+ log(message) {
56
+ let meta = `${(/* @__PURE__ */ new Date()).toISOString()}`;
57
+ if (this.name) meta = `${this.name} ${meta}`;
58
+ message = `[${meta}] ${message}`;
59
+ this.configuration.log(message);
60
+ }
61
+ };
84
62
 
63
+ //#endregion
85
64
  export { Logger };
86
- //# sourceMappingURL=hocuspocus-logger.esm.js.map
65
+ //# sourceMappingURL=hocuspocus-logger.esm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"hocuspocus-logger.esm.js","sources":["../src/Logger.ts"],"sourcesContent":[null],"names":[],"mappings":"MA6Da,MAAM,CAAA;AAiBlB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA4C,EAAA;QAnBxD,IAAI,CAAA,IAAA,GAAkB,IAAI;AAE1B,QAAA,IAAA,CAAA,aAAa,GAAwB;AACpC,YAAA,MAAM,EAAE,IAAI;AACZ,YAAA,cAAc,EAAE,IAAI;AACpB,YAAA,QAAQ,EAAE,IAAI;AACd,YAAA,eAAe,EAAE,IAAI;AACrB,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,YAAY,EAAE,IAAI;AAClB,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,SAAS,EAAE,IAAI;AACf,YAAA,WAAW,EAAE,IAAI;AACjB,YAAA,GAAG,EAAE,OAAO,CAAC,GAAG;SAChB;QAMA,IAAI,CAAC,aAAa,GAAG;YACpB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SAChB;;IAGF,MAAM,WAAW,CAAC,IAAwB,EAAA;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI;AAE5C,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;YACpC;;AAGD,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;AAC9B,YAAA,OAAO,CAAC,IAAI,CACX,6GAA6G,CAC7G;;;IAIH,MAAM,cAAc,CAAC,IAA2B,EAAA;AAC/C,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YACtC,IAAI,CAAC,GAAG,CAAC,CAAA,iBAAA,EAAoB,IAAI,CAAC,YAAY,CAAI,EAAA,CAAA,CAAC;;;IAIrD,MAAM,QAAQ,CAAC,IAAqB,EAAA;AACnC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,CAAA,UAAA,EAAa,IAAI,CAAC,YAAY,CAAY,UAAA,CAAA,CAAC;;;IAItD,MAAM,eAAe,CAAC,IAAyB,EAAA;AAC9C,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE;YACvC,IAAI,CAAC,GAAG,CAAC,CAAA,OAAA,EAAU,IAAI,CAAC,YAAY,CAAI,EAAA,CAAA,CAAC;;;IAI3C,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YACjC,IAAI,CAAC,GAAG,CAAC,CAAA,mBAAA,EAAsB,IAAI,CAAC,YAAY,CAAI,EAAA,CAAA,CAAC;;;IAIvD,MAAM,YAAY,CAAC,IAAyB,EAAA;AAC3C,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,CAAA,eAAA,EAAkB,IAAI,CAAC,YAAY,CAAW,SAAA,CAAA,CAAC;;;IAI1D,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;AACjC,YAAA,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC;;;IAIpC,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YACjC,IAAI,CAAC,GAAG,CAAC,CAA4B,yBAAA,EAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAE,CAAA,CAAC;;;IAI1D,MAAM,SAAS,CAAC,IAAsB,EAAA;AACrC,QAAA,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;AACjC,YAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC;;;AAIhB,IAAA,GAAG,CAAC,OAAe,EAAA;QAC1B,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;AACrC,QAAA,IAAI,IAAI,GAAG,CAAG,EAAA,IAAI,EAAE;AAEpB,QAAA,IAAI,IAAI,CAAC,IAAI,EAAE;YACd,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,CAAI,CAAA,EAAA,IAAI,EAAE;;AAG9B,QAAA,OAAO,GAAG,CAAI,CAAA,EAAA,IAAI,CAAK,EAAA,EAAA,OAAO,EAAE;AAEhC,QAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC;;AAEhC;;;;"}
1
+ {"version":3,"file":"hocuspocus-logger.esm.js","names":[],"sources":["../src/Logger.ts"],"sourcesContent":["import type {\n\tExtension,\n\tonChangePayload,\n\tonConfigurePayload,\n\tonConnectPayload,\n\tonLoadDocumentPayload,\n\tonDestroyPayload,\n\tonDisconnectPayload,\n\tonRequestPayload,\n\tonUpgradePayload,\n} from \"@hocuspocus/server\";\n\nexport interface LoggerConfiguration {\n\t/**\n\t * Prepend all logging message with a string.\n\t *\n\t * @deprecated\n\t */\n\tprefix: null | string;\n\t/**\n\t * Whether to log something for the `onLoadDocument` hook.\n\t */\n\tonLoadDocument: boolean;\n\t/**\n\t * Whether to log something for the `onChange` hook.\n\t */\n\tonChange: boolean;\n\t/**\n\t * Whether to log something for the `onStoreDocument` hook.\n\t */\n\tonStoreDocument: boolean;\n\t/**\n\t * Whether to log something for the `onConnect` hook.\n\t */\n\tonConnect: boolean;\n\t/**\n\t * Whether to log something for the `onDisconnect` hook.\n\t */\n\tonDisconnect: boolean;\n\t/**\n\t * Whether to log something for the `onUpgrade` hook.\n\t */\n\tonUpgrade: boolean;\n\t/**\n\t * Whether to log something for the `onRequest` hook.\n\t */\n\tonRequest: boolean;\n\t/**\n\t * Whether to log something for the `onDestroy` hook.\n\t */\n\tonDestroy: boolean;\n\t/**\n\t * Whether to log something for the `onConfigure` hook.\n\t */\n\tonConfigure: boolean;\n\t/**\n\t * A log function, if none is provided output will go to console\n\t */\n\tlog: (...args: any[]) => void;\n}\n\nexport class Logger implements Extension {\n\tname: string | null = null;\n\n\tconfiguration: LoggerConfiguration = {\n\t\tprefix: null,\n\t\tonLoadDocument: true,\n\t\tonChange: true,\n\t\tonStoreDocument: true,\n\t\tonConnect: true,\n\t\tonDisconnect: true,\n\t\tonUpgrade: true,\n\t\tonRequest: true,\n\t\tonDestroy: true,\n\t\tonConfigure: true,\n\t\tlog: console.log, // eslint-disable-line\n\t};\n\n\t/**\n\t * Constructor\n\t */\n\tconstructor(configuration?: Partial<LoggerConfiguration>) {\n\t\tthis.configuration = {\n\t\t\t...this.configuration,\n\t\t\t...configuration,\n\t\t};\n\t}\n\n\tasync onConfigure(data: onConfigurePayload) {\n\t\tthis.name = data.instance.configuration.name;\n\n\t\tif (!this.configuration.onConfigure) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (this.configuration.prefix) {\n\t\t\tconsole.warn(\n\t\t\t\t\"[hocuspocus warn] The Logger 'prefix' is deprecated. Pass a 'name' to the Hocuspocus configuration instead.\",\n\t\t\t);\n\t\t}\n\t}\n\n\tasync onLoadDocument(data: onLoadDocumentPayload) {\n\t\tif (this.configuration.onLoadDocument) {\n\t\t\tthis.log(`Loaded document \"${data.documentName}\".`);\n\t\t}\n\t}\n\n\tasync onChange(data: onChangePayload) {\n\t\tif (this.configuration.onChange) {\n\t\t\tthis.log(`Document \"${data.documentName}\" changed.`);\n\t\t}\n\t}\n\n\tasync onStoreDocument(data: onDisconnectPayload) {\n\t\tif (this.configuration.onStoreDocument) {\n\t\t\tthis.log(`Store \"${data.documentName}\".`);\n\t\t}\n\t}\n\n\tasync onConnect(data: onConnectPayload) {\n\t\tif (this.configuration.onConnect) {\n\t\t\tthis.log(`New connection to \"${data.documentName}\".`);\n\t\t}\n\t}\n\n\tasync onDisconnect(data: onDisconnectPayload) {\n\t\tif (this.configuration.onDisconnect) {\n\t\t\tthis.log(`Connection to \"${data.documentName}\" closed.`);\n\t\t}\n\t}\n\n\tasync onUpgrade(data: onUpgradePayload) {\n\t\tif (this.configuration.onUpgrade) {\n\t\t\tthis.log(\"Upgrading connection …\");\n\t\t}\n\t}\n\n\tasync onRequest(data: onRequestPayload) {\n\t\tif (this.configuration.onRequest) {\n\t\t\tthis.log(`Incoming HTTP Request to ${data.request.url}`);\n\t\t}\n\t}\n\n\tasync onDestroy(data: onDestroyPayload) {\n\t\tif (this.configuration.onDestroy) {\n\t\t\tthis.log(\"Shut down.\");\n\t\t}\n\t}\n\n\tprivate log(message: string) {\n\t\tconst date = new Date().toISOString();\n\t\tlet meta = `${date}`;\n\n\t\tif (this.name) {\n\t\t\tmeta = `${this.name} ${meta}`;\n\t\t}\n\n\t\tmessage = `[${meta}] ${message}`;\n\n\t\tthis.configuration.log(message);\n\t}\n}\n"],"mappings":";AA6DA,IAAa,SAAb,MAAyC;;;;CAoBxC,YAAY,eAA8C;cAnBpC;uBAEe;GACpC,QAAQ;GACR,gBAAgB;GAChB,UAAU;GACV,iBAAiB;GACjB,WAAW;GACX,cAAc;GACd,WAAW;GACX,WAAW;GACX,WAAW;GACX,aAAa;GACb,KAAK,QAAQ;GACb;AAMA,OAAK,gBAAgB;GACpB,GAAG,KAAK;GACR,GAAG;GACH;;CAGF,MAAM,YAAY,MAA0B;AAC3C,OAAK,OAAO,KAAK,SAAS,cAAc;AAExC,MAAI,CAAC,KAAK,cAAc,YACvB;AAGD,MAAI,KAAK,cAAc,OACtB,SAAQ,KACP,8GACA;;CAIH,MAAM,eAAe,MAA6B;AACjD,MAAI,KAAK,cAAc,eACtB,MAAK,IAAI,oBAAoB,KAAK,aAAa,IAAI;;CAIrD,MAAM,SAAS,MAAuB;AACrC,MAAI,KAAK,cAAc,SACtB,MAAK,IAAI,aAAa,KAAK,aAAa,YAAY;;CAItD,MAAM,gBAAgB,MAA2B;AAChD,MAAI,KAAK,cAAc,gBACtB,MAAK,IAAI,UAAU,KAAK,aAAa,IAAI;;CAI3C,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,sBAAsB,KAAK,aAAa,IAAI;;CAIvD,MAAM,aAAa,MAA2B;AAC7C,MAAI,KAAK,cAAc,aACtB,MAAK,IAAI,kBAAkB,KAAK,aAAa,WAAW;;CAI1D,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,yBAAyB;;CAIpC,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,4BAA4B,KAAK,QAAQ,MAAM;;CAI1D,MAAM,UAAU,MAAwB;AACvC,MAAI,KAAK,cAAc,UACtB,MAAK,IAAI,aAAa;;CAIxB,AAAQ,IAAI,SAAiB;EAE5B,IAAI,OAAO,oBADE,IAAI,MAAM,EAAC,aAAa;AAGrC,MAAI,KAAK,KACR,QAAO,GAAG,KAAK,KAAK,GAAG;AAGxB,YAAU,IAAI,KAAK,IAAI;AAEvB,OAAK,cAAc,IAAI,QAAQ"}
@@ -0,0 +1,71 @@
1
+ import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onDestroyPayload, onDisconnectPayload, onLoadDocumentPayload, onRequestPayload, onUpgradePayload } from "@hocuspocus/server";
2
+
3
+ //#region packages/extension-logger/src/Logger.d.ts
4
+ interface LoggerConfiguration {
5
+ /**
6
+ * Prepend all logging message with a string.
7
+ *
8
+ * @deprecated
9
+ */
10
+ prefix: null | string;
11
+ /**
12
+ * Whether to log something for the `onLoadDocument` hook.
13
+ */
14
+ onLoadDocument: boolean;
15
+ /**
16
+ * Whether to log something for the `onChange` hook.
17
+ */
18
+ onChange: boolean;
19
+ /**
20
+ * Whether to log something for the `onStoreDocument` hook.
21
+ */
22
+ onStoreDocument: boolean;
23
+ /**
24
+ * Whether to log something for the `onConnect` hook.
25
+ */
26
+ onConnect: boolean;
27
+ /**
28
+ * Whether to log something for the `onDisconnect` hook.
29
+ */
30
+ onDisconnect: boolean;
31
+ /**
32
+ * Whether to log something for the `onUpgrade` hook.
33
+ */
34
+ onUpgrade: boolean;
35
+ /**
36
+ * Whether to log something for the `onRequest` hook.
37
+ */
38
+ onRequest: boolean;
39
+ /**
40
+ * Whether to log something for the `onDestroy` hook.
41
+ */
42
+ onDestroy: boolean;
43
+ /**
44
+ * Whether to log something for the `onConfigure` hook.
45
+ */
46
+ onConfigure: boolean;
47
+ /**
48
+ * A log function, if none is provided output will go to console
49
+ */
50
+ log: (...args: any[]) => void;
51
+ }
52
+ declare class Logger implements Extension {
53
+ name: string | null;
54
+ configuration: LoggerConfiguration;
55
+ /**
56
+ * Constructor
57
+ */
58
+ constructor(configuration?: Partial<LoggerConfiguration>);
59
+ onConfigure(data: onConfigurePayload): Promise<void>;
60
+ onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
61
+ onChange(data: onChangePayload): Promise<void>;
62
+ onStoreDocument(data: onDisconnectPayload): Promise<void>;
63
+ onConnect(data: onConnectPayload): Promise<void>;
64
+ onDisconnect(data: onDisconnectPayload): Promise<void>;
65
+ onUpgrade(data: onUpgradePayload): Promise<void>;
66
+ onRequest(data: onRequestPayload): Promise<void>;
67
+ onDestroy(data: onDestroyPayload): Promise<void>;
68
+ private log;
69
+ }
70
+ //#endregion
71
+ export { Logger, LoggerConfiguration };
package/dist/index.js ADDED
@@ -0,0 +1,64 @@
1
+ //#region packages/extension-logger/src/Logger.ts
2
+ var Logger = class {
3
+ /**
4
+ * Constructor
5
+ */
6
+ constructor(configuration) {
7
+ this.name = null;
8
+ this.configuration = {
9
+ prefix: null,
10
+ onLoadDocument: true,
11
+ onChange: true,
12
+ onStoreDocument: true,
13
+ onConnect: true,
14
+ onDisconnect: true,
15
+ onUpgrade: true,
16
+ onRequest: true,
17
+ onDestroy: true,
18
+ onConfigure: true,
19
+ log: console.log
20
+ };
21
+ this.configuration = {
22
+ ...this.configuration,
23
+ ...configuration
24
+ };
25
+ }
26
+ async onConfigure(data) {
27
+ this.name = data.instance.configuration.name;
28
+ if (!this.configuration.onConfigure) return;
29
+ if (this.configuration.prefix) console.warn("[hocuspocus warn] The Logger 'prefix' is deprecated. Pass a 'name' to the Hocuspocus configuration instead.");
30
+ }
31
+ async onLoadDocument(data) {
32
+ if (this.configuration.onLoadDocument) this.log(`Loaded document "${data.documentName}".`);
33
+ }
34
+ async onChange(data) {
35
+ if (this.configuration.onChange) this.log(`Document "${data.documentName}" changed.`);
36
+ }
37
+ async onStoreDocument(data) {
38
+ if (this.configuration.onStoreDocument) this.log(`Store "${data.documentName}".`);
39
+ }
40
+ async onConnect(data) {
41
+ if (this.configuration.onConnect) this.log(`New connection to "${data.documentName}".`);
42
+ }
43
+ async onDisconnect(data) {
44
+ if (this.configuration.onDisconnect) this.log(`Connection to "${data.documentName}" closed.`);
45
+ }
46
+ async onUpgrade(data) {
47
+ if (this.configuration.onUpgrade) this.log("Upgrading connection …");
48
+ }
49
+ async onRequest(data) {
50
+ if (this.configuration.onRequest) this.log(`Incoming HTTP Request to ${data.request.url}`);
51
+ }
52
+ async onDestroy(data) {
53
+ if (this.configuration.onDestroy) this.log("Shut down.");
54
+ }
55
+ log(message) {
56
+ let meta = `${(/* @__PURE__ */ new Date()).toISOString()}`;
57
+ if (this.name) meta = `${this.name} ${meta}`;
58
+ message = `[${meta}] ${message}`;
59
+ this.configuration.log(message);
60
+ }
61
+ };
62
+
63
+ //#endregion
64
+ export { Logger };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hocuspocus/extension-logger",
3
- "version": "3.4.3",
3
+ "version": "3.4.5-rc.0",
4
4
  "description": "hocuspocus logging extension",
5
5
  "homepage": "https://hocuspocus.dev",
6
6
  "keywords": [
@@ -13,7 +13,7 @@
13
13
  "type": "module",
14
14
  "main": "dist/hocuspocus-logger.cjs",
15
15
  "module": "dist/hocuspocus-logger.esm.js",
16
- "types": "dist/packages/extension-logger/src/index.d.ts",
16
+ "types": "dist/index.d.ts",
17
17
  "exports": {
18
18
  "source": {
19
19
  "import": "./src/index.ts"
@@ -21,7 +21,7 @@
21
21
  "default": {
22
22
  "import": "./dist/hocuspocus-logger.esm.js",
23
23
  "require": "./dist/hocuspocus-logger.cjs",
24
- "types": "./dist/packages/extension-logger/src/index.d.ts"
24
+ "types": "./dist/index.d.ts"
25
25
  }
26
26
  },
27
27
  "files": [
@@ -29,7 +29,7 @@
29
29
  "dist"
30
30
  ],
31
31
  "dependencies": {
32
- "@hocuspocus/server": "^3.4.3"
32
+ "@hocuspocus/server": "^3.4.5-rc.0"
33
33
  },
34
34
  "gitHead": "b3454a4ca289a84ddfb7fa5607a2d4b8d5c37e9d",
35
35
  "repository": {
@@ -1 +0,0 @@
1
- export * from 'prosemirror-model';
@@ -1 +0,0 @@
1
- export * from 'prosemirror-state';
@@ -1 +0,0 @@
1
- export * from 'prosemirror-transform';
@@ -1 +0,0 @@
1
- export * from 'prosemirror-view';
@@ -1,29 +0,0 @@
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,12 +0,0 @@
1
- import * as encoding from "lib0/encoding";
2
- import * as decoding from "lib0/decoding";
3
- export declare enum AuthMessageType {
4
- Token = 0,
5
- PermissionDenied = 1,
6
- Authenticated = 2
7
- }
8
- export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
9
- export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
10
- export declare const writeAuthenticated: (encoder: encoding.Encoder, scope: "readonly" | "read-write") => void;
11
- export declare const writeTokenSyncRequest: (encoder: encoding.Encoder) => void;
12
- export declare const readAuthMessage: (decoder: decoding.Decoder, sendToken: () => void, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;
@@ -1,3 +0,0 @@
1
- export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
2
- clientId: number;
3
- }[];
@@ -1,4 +0,0 @@
1
- export * from "./auth.ts";
2
- export * from "./CloseEvents.ts";
3
- export * from "./awarenessStatesToArray.ts";
4
- export * from "./types.ts";
@@ -1,10 +0,0 @@
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 +0,0 @@
1
- import type { 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) => Promise<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 +0,0 @@
1
- export * from "./Database.ts";