@hocuspocus/extension-logger 1.0.0-alpha.59 → 1.0.0-alpha.63

package/dist/hocuspocus-logger.cjs

@@ -16,7 +16,6 @@ class Logger {
             onDisconnect: true,
             onUpgrade: true,
             onRequest: true,
-            onListen: true,
             onDestroy: true,
             onConfigure: true,
             log: console.log, // eslint-disable-line
@@ -26,6 +25,15 @@ class Logger {
             ...configuration,
         };
     }
+    async onConfigure(data) {
+        this.name = data.instance.configuration.name;
+        if (!this.configuration.onConfigure) {
+            return;
+        }
+        if (this.configuration.prefix) {
+            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
+        }
+    }
     async onLoadDocument(data) {
         if (this.configuration.onLoadDocument) {
             this.log(`Loaded document "${data.documentName}".`);
@@ -56,57 +64,19 @@ class Logger {
             this.log(`Incoming HTTP Request to ${data.request.url}`);
         }
     }
-    async onListen(data) {
-        if (this.configuration.onListen) {
-            this.logRawText('Ready.');
-            this.logRawText();
-        }
-    }
     async onDestroy(data) {
         if (this.configuration.onDestroy) {
             this.log('Shut down.');
         }
     }
-    async onConfigure(data) {
-        var _a;
-        if (!this.configuration.onConfigure) {
-            return;
-        }
-        if (this.configuration.prefix) {
-            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
-        }
-        this.name = data.instance.configuration.name;
-        this.logRawText();
-        this.logRawText(`Hocuspocus v${data.version} running at:`);
-        this.logRawText();
-        this.logRawText(`> HTTP: http://127.0.0.1:${data.configuration.port}`);
-        this.logRawText(`> WebSocket: ws://127.0.0.1:${data.configuration.port}`);
-        const { instance } = data;
-        const extensions = (_a = instance.configuration) === null || _a === void 0 ? void 0 : _a.extensions.map(extension => {
-            var _a;
-            return (_a = extension.constructor) === null || _a === void 0 ? void 0 : _a.name;
-        }).filter(name => name).filter(name => name !== 'Object');
-        if (!extensions.length) {
-            return;
-        }
-        this.logRawText();
-        this.logRawText('Extensions:');
-        extensions
-            .forEach(name => {
-            this.logRawText(`- ${name}`);
-        });
-        this.logRawText();
-    }
-    logRawText(message = '') {
-        this.configuration.log(message);
-    }
     log(message) {
-        message = `[${(new Date()).toISOString()}] ${message}`;
-        const name = this.name ? this.name : this.configuration.prefix;
-        if (name) {
-            message = `[${name}] ${message}`;
+        const date = (new Date()).toISOString();
+        let meta = `${date}`;
+        if (this.name) {
+            meta = `${this.name} ${meta}`;
         }
-        this.logRawText(message);
+        message = `[${meta}] ${message}`;
+        this.configuration.log(message);
     }
 }
 

package/dist/hocuspocus-logger.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-logger.cjs","sources":["../src/Logger.ts"],"sourcesContent":["import {\n  Extension,\n  onChangePayload,\n  onConfigurePayload,\n  onConnectPayload,\n  onLoadDocumentPayload,\n  onDestroyPayload,\n  onDisconnectPayload,\n  onListenPayload,\n  onRequestPayload,\n  onUpgradePayload,\n} from '@hocuspocus/server'\n\nexport interface LoggerConfiguration {\n  /**\n   * Prepend all logging message with a string.\n   *\n   * @deprecated\n   */\n  prefix: null | string,\n  /**\n   * Whether to log something for the `onLoadDocument` hook.\n   */\n  onLoadDocument: boolean,\n  /**\n   * Whether to log something for the `onChange` hook.\n   */\n  onChange: boolean,\n  /**\n   * Whether to log something for the `onConnect` hook.\n   */\n  onConnect: boolean,\n  /**\n   * Whether to log something for the `onDisconnect` hook.\n   */\n  onDisconnect: boolean,\n  /**\n   * Whether to log something for the `onUpgrade` hook.\n   */\n  onUpgrade: boolean,\n  /**\n   * Whether to log something for the `onRequest` hook.\n   */\n  onRequest: boolean,\n  /**\n   * Whether to log something for the `onListen` hook.\n   */\n  onListen: boolean,\n  /**\n   * Whether to log something for the `onDestroy` hook.\n   */\n  onDestroy: boolean,\n  /**\n   * Whether to log something for the `onConfigure` hook.\n   */\n  onConfigure: boolean,\n  /**\n   * A log function, if none is provided output will go to console\n   */\n  log: (...args: any[]) => void,\n}\n\nexport class Logger implements Extension {\n  name: string | null = null\n\n  configuration: LoggerConfiguration = {\n    prefix: null,\n    onLoadDocument: true,\n    onChange: true,\n    onConnect: true,\n    onDisconnect: true,\n    onUpgrade: true,\n    onRequest: true,\n    onListen: true,\n    onDestroy: true,\n    onConfigure: true,\n    log: console.log, // eslint-disable-line\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<LoggerConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onLoadDocument(data: onLoadDocumentPayload) {\n    if (this.configuration.onLoadDocument) {\n      this.log(`Loaded document \"${data.documentName}\".`)\n    }\n  }\n\n  async onChange(data: onChangePayload) {\n    if (this.configuration.onChange) {\n      this.log(`Document \"${data.documentName}\" changed.`)\n    }\n  }\n\n  async onConnect(data: onConnectPayload) {\n    if (this.configuration.onConnect) {\n      this.log(`New connection to \"${data.documentName}\".`)\n    }\n  }\n\n  async onDisconnect(data: onDisconnectPayload) {\n    if (this.configuration.onDisconnect) {\n      this.log(`Connection to \"${data.documentName}\" closed.`)\n    }\n  }\n\n  async onUpgrade(data: onUpgradePayload) {\n    if (this.configuration.onUpgrade) {\n      this.log('Upgrading connection …')\n    }\n  }\n\n  async onRequest(data: onRequestPayload) {\n    if (this.configuration.onRequest) {\n      this.log(`Incoming HTTP Request to ${data.request.url}`)\n    }\n  }\n\n  async onListen(data: onListenPayload) {\n    if (this.configuration.onListen) {\n      this.logRawText('Ready.')\n      this.logRawText()\n    }\n  }\n\n  async onDestroy(data: onDestroyPayload) {\n    if (this.configuration.onDestroy) {\n      this.log('Shut down.')\n    }\n  }\n\n  async onConfigure(data: onConfigurePayload) {\n    if (!this.configuration.onConfigure) {\n      return\n    }\n\n    if (this.configuration.prefix) {\n      console.warn('[hocuspocus warn] The Logger \\'prefix\\' is deprecated. Pass a \\'name\\' to the Hocuspocus configuration instead.')\n    }\n\n    this.name = data.instance.configuration.name\n\n    this.logRawText()\n    this.logRawText(`Hocuspocus v${data.version} running at:`)\n    this.logRawText()\n    this.logRawText(`> HTTP: http://127.0.0.1:${data.configuration.port}`)\n    this.logRawText(`> WebSocket: ws://127.0.0.1:${data.configuration.port}`)\n\n    const { instance } = data\n\n    const extensions = instance.configuration?.extensions.map(extension => {\n      return extension.constructor?.name\n    })\n      .filter(name => name)\n      .filter(name => name !== 'Object')\n\n    if (!extensions.length) {\n      return\n    }\n\n    this.logRawText()\n    this.logRawText('Extensions:')\n\n    extensions\n      .forEach(name => {\n        this.logRawText(`- ${name}`)\n      })\n\n    this.logRawText()\n  }\n\n  private logRawText(message = '') {\n    this.configuration.log(message)\n  }\n\n  private log(message: string) {\n    message = `[${(new Date()).toISOString()}] ${message}`\n\n    const name = this.name ? this.name : this.configuration.prefix\n\n    if (name) {\n      message = `[${name}] ${message}`\n    }\n\n    this.logRawText(message)\n  }\n\n}\n"],"names":[],"mappings":";;;;MA8Da,MAAM;;;;IAoBjB,YAAY,aAA4C;QAnBxD,SAAI,GAAkB,IAAI,CAAA;QAE1B,kBAAa,GAAwB;YACnC,MAAM,EAAE,IAAI;YACZ,cAAc,EAAE,IAAI;YACpB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,IAAI;YAClB,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,cAAc,CAAC,IAA2B;QAC9C,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACpD;KACF;IAED,MAAM,QAAQ,CAAC,IAAqB;QAClC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,YAAY,YAAY,CAAC,CAAA;SACrD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,sBAAsB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACtD;KACF;IAED,MAAM,YAAY,CAAC,IAAyB;QAC1C,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;YACnC,IAAI,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,YAAY,WAAW,CAAC,CAAA;SACzD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;SACnC;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,4BAA4B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;SACzD;KACF;IAED,MAAM,QAAQ,CAAC,IAAqB;QAClC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAC/B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;YACzB,IAAI,CAAC,UAAU,EAAE,CAAA;SAClB;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;SACvB;KACF;IAED,MAAM,WAAW,CAAC,IAAwB;;QACxC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;YACnC,OAAM;SACP;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,IAAI,CAAC,iHAAiH,CAAC,CAAA;SAChI;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAA;QAE5C,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,eAAe,IAAI,CAAC,OAAO,cAAc,CAAC,CAAA;QAC1D,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,4BAA4B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAA;QACtE,IAAI,CAAC,UAAU,CAAC,+BAA+B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAA;QAEzE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAEzB,MAAM,UAAU,GAAG,MAAA,QAAQ,CAAC,aAAa,0CAAE,UAAU,CAAC,GAAG,CAAC,SAAS;;YACjE,OAAO,MAAA,SAAS,CAAC,WAAW,0CAAE,IAAI,CAAA;SACnC,EACE,MAAM,CAAC,IAAI,IAAI,IAAI,EACnB,MAAM,CAAC,IAAI,IAAI,IAAI,KAAK,QAAQ,CAAC,CAAA;QAEpC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACtB,OAAM;SACP;QAED,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;QAE9B,UAAU;aACP,OAAO,CAAC,IAAI;YACX,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;SAC7B,CAAC,CAAA;QAEJ,IAAI,CAAC,UAAU,EAAE,CAAA;KAClB;IAEO,UAAU,CAAC,OAAO,GAAG,EAAE;QAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;KAChC;IAEO,GAAG,CAAC,OAAe;QACzB,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,OAAO,EAAE,CAAA;QAEtD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA;QAE9D,IAAI,IAAI,EAAE;YACR,OAAO,GAAG,IAAI,IAAI,KAAK,OAAO,EAAE,CAAA;SACjC;QAED,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;KACzB;;;;;"}
+{"version":3,"file":"hocuspocus-logger.cjs","sources":["../src/Logger.ts"],"sourcesContent":["import {\n  Extension,\n  onChangePayload,\n  onConfigurePayload,\n  onConnectPayload,\n  onLoadDocumentPayload,\n  onDestroyPayload,\n  onDisconnectPayload,\n  onRequestPayload,\n  onUpgradePayload,\n} from '@hocuspocus/server'\n\nexport interface LoggerConfiguration {\n  /**\n   * Prepend all logging message with a string.\n   *\n   * @deprecated\n   */\n  prefix: null | string,\n  /**\n   * Whether to log something for the `onLoadDocument` hook.\n   */\n  onLoadDocument: boolean,\n  /**\n   * Whether to log something for the `onChange` hook.\n   */\n  onChange: boolean,\n  /**\n   * Whether to log something for the `onConnect` hook.\n   */\n  onConnect: boolean,\n  /**\n   * Whether to log something for the `onDisconnect` hook.\n   */\n  onDisconnect: boolean,\n  /**\n   * Whether to log something for the `onUpgrade` hook.\n   */\n  onUpgrade: boolean,\n  /**\n   * Whether to log something for the `onRequest` hook.\n   */\n  onRequest: boolean,\n  /**\n   * Whether to log something for the `onDestroy` hook.\n   */\n  onDestroy: boolean,\n  /**\n   * Whether to log something for the `onConfigure` hook.\n   */\n  onConfigure: boolean,\n  /**\n   * A log function, if none is provided output will go to console\n   */\n  log: (...args: any[]) => void,\n}\n\nexport class Logger implements Extension {\n  name: string | null = null\n\n  configuration: LoggerConfiguration = {\n    prefix: null,\n    onLoadDocument: true,\n    onChange: true,\n    onConnect: true,\n    onDisconnect: true,\n    onUpgrade: true,\n    onRequest: true,\n    onDestroy: true,\n    onConfigure: true,\n    log: console.log, // eslint-disable-line\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<LoggerConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onConfigure(data: onConfigurePayload) {\n    this.name = data.instance.configuration.name\n\n    if (!this.configuration.onConfigure) {\n      return\n    }\n\n    if (this.configuration.prefix) {\n      console.warn('[hocuspocus warn] The Logger \\'prefix\\' is deprecated. Pass a \\'name\\' to the Hocuspocus configuration instead.')\n    }\n  }\n\n  async onLoadDocument(data: onLoadDocumentPayload) {\n    if (this.configuration.onLoadDocument) {\n      this.log(`Loaded document \"${data.documentName}\".`)\n    }\n  }\n\n  async onChange(data: onChangePayload) {\n    if (this.configuration.onChange) {\n      this.log(`Document \"${data.documentName}\" changed.`)\n    }\n  }\n\n  async onConnect(data: onConnectPayload) {\n    if (this.configuration.onConnect) {\n      this.log(`New connection to \"${data.documentName}\".`)\n    }\n  }\n\n  async onDisconnect(data: onDisconnectPayload) {\n    if (this.configuration.onDisconnect) {\n      this.log(`Connection to \"${data.documentName}\" closed.`)\n    }\n  }\n\n  async onUpgrade(data: onUpgradePayload) {\n    if (this.configuration.onUpgrade) {\n      this.log('Upgrading connection …')\n    }\n  }\n\n  async onRequest(data: onRequestPayload) {\n    if (this.configuration.onRequest) {\n      this.log(`Incoming HTTP Request to ${data.request.url}`)\n    }\n  }\n\n  async onDestroy(data: onDestroyPayload) {\n    if (this.configuration.onDestroy) {\n      this.log('Shut down.')\n    }\n  }\n\n  private log(message: string) {\n    const date = (new Date()).toISOString()\n    let meta = `${date}`\n\n    if (this.name) {\n      meta = `${this.name} ${meta}`\n    }\n\n    message = `[${meta}] ${message}`\n\n    this.configuration.log(message)\n  }\n\n}\n"],"names":[],"mappings":";;;;MAyDa,MAAM;;;;IAmBjB,YAAY,aAA4C;QAlBxD,SAAI,GAAkB,IAAI,CAAA;QAE1B,kBAAa,GAAwB;YACnC,MAAM,EAAE,IAAI;YACZ,cAAc,EAAE,IAAI;YACpB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,IAAI;YAClB,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,WAAW,CAAC,IAAwB;QACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAA;QAE5C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;YACnC,OAAM;SACP;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,IAAI,CAAC,iHAAiH,CAAC,CAAA;SAChI;KACF;IAED,MAAM,cAAc,CAAC,IAA2B;QAC9C,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACpD;KACF;IAED,MAAM,QAAQ,CAAC,IAAqB;QAClC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,YAAY,YAAY,CAAC,CAAA;SACrD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,sBAAsB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACtD;KACF;IAED,MAAM,YAAY,CAAC,IAAyB;QAC1C,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;YACnC,IAAI,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,YAAY,WAAW,CAAC,CAAA;SACzD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;SACnC;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,4BAA4B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;SACzD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;SACvB;KACF;IAEO,GAAG,CAAC,OAAe;QACzB,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,WAAW,EAAE,CAAA;QACvC,IAAI,IAAI,GAAG,GAAG,IAAI,EAAE,CAAA;QAEpB,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAA;SAC9B;QAED,OAAO,GAAG,IAAI,IAAI,KAAK,OAAO,EAAE,CAAA;QAEhC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;KAChC;;;;;"}

package/dist/hocuspocus-logger.esm.js

@@ -12,7 +12,6 @@ class Logger {
             onDisconnect: true,
             onUpgrade: true,
             onRequest: true,
-            onListen: true,
             onDestroy: true,
             onConfigure: true,
             log: console.log, // eslint-disable-line
@@ -22,6 +21,15 @@ class Logger {
             ...configuration,
         };
     }
+    async onConfigure(data) {
+        this.name = data.instance.configuration.name;
+        if (!this.configuration.onConfigure) {
+            return;
+        }
+        if (this.configuration.prefix) {
+            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
+        }
+    }
     async onLoadDocument(data) {
         if (this.configuration.onLoadDocument) {
             this.log(`Loaded document "${data.documentName}".`);
@@ -52,57 +60,19 @@ class Logger {
             this.log(`Incoming HTTP Request to ${data.request.url}`);
         }
     }
-    async onListen(data) {
-        if (this.configuration.onListen) {
-            this.logRawText('Ready.');
-            this.logRawText();
-        }
-    }
     async onDestroy(data) {
         if (this.configuration.onDestroy) {
             this.log('Shut down.');
         }
     }
-    async onConfigure(data) {
-        var _a;
-        if (!this.configuration.onConfigure) {
-            return;
-        }
-        if (this.configuration.prefix) {
-            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
-        }
-        this.name = data.instance.configuration.name;
-        this.logRawText();
-        this.logRawText(`Hocuspocus v${data.version} running at:`);
-        this.logRawText();
-        this.logRawText(`> HTTP: http://127.0.0.1:${data.configuration.port}`);
-        this.logRawText(`> WebSocket: ws://127.0.0.1:${data.configuration.port}`);
-        const { instance } = data;
-        const extensions = (_a = instance.configuration) === null || _a === void 0 ? void 0 : _a.extensions.map(extension => {
-            var _a;
-            return (_a = extension.constructor) === null || _a === void 0 ? void 0 : _a.name;
-        }).filter(name => name).filter(name => name !== 'Object');
-        if (!extensions.length) {
-            return;
-        }
-        this.logRawText();
-        this.logRawText('Extensions:');
-        extensions
-            .forEach(name => {
-            this.logRawText(`- ${name}`);
-        });
-        this.logRawText();
-    }
-    logRawText(message = '') {
-        this.configuration.log(message);
-    }
     log(message) {
-        message = `[${(new Date()).toISOString()}] ${message}`;
-        const name = this.name ? this.name : this.configuration.prefix;
-        if (name) {
-            message = `[${name}] ${message}`;
+        const date = (new Date()).toISOString();
+        let meta = `${date}`;
+        if (this.name) {
+            meta = `${this.name} ${meta}`;
         }
-        this.logRawText(message);
+        message = `[${meta}] ${message}`;
+        this.configuration.log(message);
     }
 }
 

package/dist/hocuspocus-logger.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-logger.esm.js","sources":["../src/Logger.ts"],"sourcesContent":["import {\n  Extension,\n  onChangePayload,\n  onConfigurePayload,\n  onConnectPayload,\n  onLoadDocumentPayload,\n  onDestroyPayload,\n  onDisconnectPayload,\n  onListenPayload,\n  onRequestPayload,\n  onUpgradePayload,\n} from '@hocuspocus/server'\n\nexport interface LoggerConfiguration {\n  /**\n   * Prepend all logging message with a string.\n   *\n   * @deprecated\n   */\n  prefix: null | string,\n  /**\n   * Whether to log something for the `onLoadDocument` hook.\n   */\n  onLoadDocument: boolean,\n  /**\n   * Whether to log something for the `onChange` hook.\n   */\n  onChange: boolean,\n  /**\n   * Whether to log something for the `onConnect` hook.\n   */\n  onConnect: boolean,\n  /**\n   * Whether to log something for the `onDisconnect` hook.\n   */\n  onDisconnect: boolean,\n  /**\n   * Whether to log something for the `onUpgrade` hook.\n   */\n  onUpgrade: boolean,\n  /**\n   * Whether to log something for the `onRequest` hook.\n   */\n  onRequest: boolean,\n  /**\n   * Whether to log something for the `onListen` hook.\n   */\n  onListen: boolean,\n  /**\n   * Whether to log something for the `onDestroy` hook.\n   */\n  onDestroy: boolean,\n  /**\n   * Whether to log something for the `onConfigure` hook.\n   */\n  onConfigure: boolean,\n  /**\n   * A log function, if none is provided output will go to console\n   */\n  log: (...args: any[]) => void,\n}\n\nexport class Logger implements Extension {\n  name: string | null = null\n\n  configuration: LoggerConfiguration = {\n    prefix: null,\n    onLoadDocument: true,\n    onChange: true,\n    onConnect: true,\n    onDisconnect: true,\n    onUpgrade: true,\n    onRequest: true,\n    onListen: true,\n    onDestroy: true,\n    onConfigure: true,\n    log: console.log, // eslint-disable-line\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<LoggerConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onLoadDocument(data: onLoadDocumentPayload) {\n    if (this.configuration.onLoadDocument) {\n      this.log(`Loaded document \"${data.documentName}\".`)\n    }\n  }\n\n  async onChange(data: onChangePayload) {\n    if (this.configuration.onChange) {\n      this.log(`Document \"${data.documentName}\" changed.`)\n    }\n  }\n\n  async onConnect(data: onConnectPayload) {\n    if (this.configuration.onConnect) {\n      this.log(`New connection to \"${data.documentName}\".`)\n    }\n  }\n\n  async onDisconnect(data: onDisconnectPayload) {\n    if (this.configuration.onDisconnect) {\n      this.log(`Connection to \"${data.documentName}\" closed.`)\n    }\n  }\n\n  async onUpgrade(data: onUpgradePayload) {\n    if (this.configuration.onUpgrade) {\n      this.log('Upgrading connection …')\n    }\n  }\n\n  async onRequest(data: onRequestPayload) {\n    if (this.configuration.onRequest) {\n      this.log(`Incoming HTTP Request to ${data.request.url}`)\n    }\n  }\n\n  async onListen(data: onListenPayload) {\n    if (this.configuration.onListen) {\n      this.logRawText('Ready.')\n      this.logRawText()\n    }\n  }\n\n  async onDestroy(data: onDestroyPayload) {\n    if (this.configuration.onDestroy) {\n      this.log('Shut down.')\n    }\n  }\n\n  async onConfigure(data: onConfigurePayload) {\n    if (!this.configuration.onConfigure) {\n      return\n    }\n\n    if (this.configuration.prefix) {\n      console.warn('[hocuspocus warn] The Logger \\'prefix\\' is deprecated. Pass a \\'name\\' to the Hocuspocus configuration instead.')\n    }\n\n    this.name = data.instance.configuration.name\n\n    this.logRawText()\n    this.logRawText(`Hocuspocus v${data.version} running at:`)\n    this.logRawText()\n    this.logRawText(`> HTTP: http://127.0.0.1:${data.configuration.port}`)\n    this.logRawText(`> WebSocket: ws://127.0.0.1:${data.configuration.port}`)\n\n    const { instance } = data\n\n    const extensions = instance.configuration?.extensions.map(extension => {\n      return extension.constructor?.name\n    })\n      .filter(name => name)\n      .filter(name => name !== 'Object')\n\n    if (!extensions.length) {\n      return\n    }\n\n    this.logRawText()\n    this.logRawText('Extensions:')\n\n    extensions\n      .forEach(name => {\n        this.logRawText(`- ${name}`)\n      })\n\n    this.logRawText()\n  }\n\n  private logRawText(message = '') {\n    this.configuration.log(message)\n  }\n\n  private log(message: string) {\n    message = `[${(new Date()).toISOString()}] ${message}`\n\n    const name = this.name ? this.name : this.configuration.prefix\n\n    if (name) {\n      message = `[${name}] ${message}`\n    }\n\n    this.logRawText(message)\n  }\n\n}\n"],"names":[],"mappings":"MA8Da,MAAM;;;;IAoBjB,YAAY,aAA4C;QAnBxD,SAAI,GAAkB,IAAI,CAAA;QAE1B,kBAAa,GAAwB;YACnC,MAAM,EAAE,IAAI;YACZ,cAAc,EAAE,IAAI;YACpB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,IAAI;YAClB,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,cAAc,CAAC,IAA2B;QAC9C,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACpD;KACF;IAED,MAAM,QAAQ,CAAC,IAAqB;QAClC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,YAAY,YAAY,CAAC,CAAA;SACrD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,sBAAsB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACtD;KACF;IAED,MAAM,YAAY,CAAC,IAAyB;QAC1C,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;YACnC,IAAI,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,YAAY,WAAW,CAAC,CAAA;SACzD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;SACnC;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,4BAA4B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;SACzD;KACF;IAED,MAAM,QAAQ,CAAC,IAAqB;QAClC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAC/B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;YACzB,IAAI,CAAC,UAAU,EAAE,CAAA;SAClB;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;SACvB;KACF;IAED,MAAM,WAAW,CAAC,IAAwB;;QACxC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;YACnC,OAAM;SACP;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,IAAI,CAAC,iHAAiH,CAAC,CAAA;SAChI;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAA;QAE5C,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,eAAe,IAAI,CAAC,OAAO,cAAc,CAAC,CAAA;QAC1D,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,4BAA4B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAA;QACtE,IAAI,CAAC,UAAU,CAAC,+BAA+B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAA;QAEzE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAEzB,MAAM,UAAU,GAAG,MAAA,QAAQ,CAAC,aAAa,0CAAE,UAAU,CAAC,GAAG,CAAC,SAAS;;YACjE,OAAO,MAAA,SAAS,CAAC,WAAW,0CAAE,IAAI,CAAA;SACnC,EACE,MAAM,CAAC,IAAI,IAAI,IAAI,EACnB,MAAM,CAAC,IAAI,IAAI,IAAI,KAAK,QAAQ,CAAC,CAAA;QAEpC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACtB,OAAM;SACP;QAED,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;QAE9B,UAAU;aACP,OAAO,CAAC,IAAI;YACX,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;SAC7B,CAAC,CAAA;QAEJ,IAAI,CAAC,UAAU,EAAE,CAAA;KAClB;IAEO,UAAU,CAAC,OAAO,GAAG,EAAE;QAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;KAChC;IAEO,GAAG,CAAC,OAAe;QACzB,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,OAAO,EAAE,CAAA;QAEtD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAA;QAE9D,IAAI,IAAI,EAAE;YACR,OAAO,GAAG,IAAI,IAAI,KAAK,OAAO,EAAE,CAAA;SACjC;QAED,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;KACzB;;;;;"}
+{"version":3,"file":"hocuspocus-logger.esm.js","sources":["../src/Logger.ts"],"sourcesContent":["import {\n  Extension,\n  onChangePayload,\n  onConfigurePayload,\n  onConnectPayload,\n  onLoadDocumentPayload,\n  onDestroyPayload,\n  onDisconnectPayload,\n  onRequestPayload,\n  onUpgradePayload,\n} from '@hocuspocus/server'\n\nexport interface LoggerConfiguration {\n  /**\n   * Prepend all logging message with a string.\n   *\n   * @deprecated\n   */\n  prefix: null | string,\n  /**\n   * Whether to log something for the `onLoadDocument` hook.\n   */\n  onLoadDocument: boolean,\n  /**\n   * Whether to log something for the `onChange` hook.\n   */\n  onChange: boolean,\n  /**\n   * Whether to log something for the `onConnect` hook.\n   */\n  onConnect: boolean,\n  /**\n   * Whether to log something for the `onDisconnect` hook.\n   */\n  onDisconnect: boolean,\n  /**\n   * Whether to log something for the `onUpgrade` hook.\n   */\n  onUpgrade: boolean,\n  /**\n   * Whether to log something for the `onRequest` hook.\n   */\n  onRequest: boolean,\n  /**\n   * Whether to log something for the `onDestroy` hook.\n   */\n  onDestroy: boolean,\n  /**\n   * Whether to log something for the `onConfigure` hook.\n   */\n  onConfigure: boolean,\n  /**\n   * A log function, if none is provided output will go to console\n   */\n  log: (...args: any[]) => void,\n}\n\nexport class Logger implements Extension {\n  name: string | null = null\n\n  configuration: LoggerConfiguration = {\n    prefix: null,\n    onLoadDocument: true,\n    onChange: true,\n    onConnect: true,\n    onDisconnect: true,\n    onUpgrade: true,\n    onRequest: true,\n    onDestroy: true,\n    onConfigure: true,\n    log: console.log, // eslint-disable-line\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<LoggerConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  async onConfigure(data: onConfigurePayload) {\n    this.name = data.instance.configuration.name\n\n    if (!this.configuration.onConfigure) {\n      return\n    }\n\n    if (this.configuration.prefix) {\n      console.warn('[hocuspocus warn] The Logger \\'prefix\\' is deprecated. Pass a \\'name\\' to the Hocuspocus configuration instead.')\n    }\n  }\n\n  async onLoadDocument(data: onLoadDocumentPayload) {\n    if (this.configuration.onLoadDocument) {\n      this.log(`Loaded document \"${data.documentName}\".`)\n    }\n  }\n\n  async onChange(data: onChangePayload) {\n    if (this.configuration.onChange) {\n      this.log(`Document \"${data.documentName}\" changed.`)\n    }\n  }\n\n  async onConnect(data: onConnectPayload) {\n    if (this.configuration.onConnect) {\n      this.log(`New connection to \"${data.documentName}\".`)\n    }\n  }\n\n  async onDisconnect(data: onDisconnectPayload) {\n    if (this.configuration.onDisconnect) {\n      this.log(`Connection to \"${data.documentName}\" closed.`)\n    }\n  }\n\n  async onUpgrade(data: onUpgradePayload) {\n    if (this.configuration.onUpgrade) {\n      this.log('Upgrading connection …')\n    }\n  }\n\n  async onRequest(data: onRequestPayload) {\n    if (this.configuration.onRequest) {\n      this.log(`Incoming HTTP Request to ${data.request.url}`)\n    }\n  }\n\n  async onDestroy(data: onDestroyPayload) {\n    if (this.configuration.onDestroy) {\n      this.log('Shut down.')\n    }\n  }\n\n  private log(message: string) {\n    const date = (new Date()).toISOString()\n    let meta = `${date}`\n\n    if (this.name) {\n      meta = `${this.name} ${meta}`\n    }\n\n    message = `[${meta}] ${message}`\n\n    this.configuration.log(message)\n  }\n\n}\n"],"names":[],"mappings":"MAyDa,MAAM;;;;IAmBjB,YAAY,aAA4C;QAlBxD,SAAI,GAAkB,IAAI,CAAA;QAE1B,kBAAa,GAAwB;YACnC,MAAM,EAAE,IAAI;YACZ,cAAc,EAAE,IAAI;YACpB,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,IAAI;YAClB,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;IAED,MAAM,WAAW,CAAC,IAAwB;QACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAA;QAE5C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;YACnC,OAAM;SACP;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,IAAI,CAAC,iHAAiH,CAAC,CAAA;SAChI;KACF;IAED,MAAM,cAAc,CAAC,IAA2B;QAC9C,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACpD;KACF;IAED,MAAM,QAAQ,CAAC,IAAqB;QAClC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,YAAY,YAAY,CAAC,CAAA;SACrD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,sBAAsB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;SACtD;KACF;IAED,MAAM,YAAY,CAAC,IAAyB;QAC1C,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;YACnC,IAAI,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,YAAY,WAAW,CAAC,CAAA;SACzD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;SACnC;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,4BAA4B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;SACzD;KACF;IAED,MAAM,SAAS,CAAC,IAAsB;QACpC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;SACvB;KACF;IAEO,GAAG,CAAC,OAAe;QACzB,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,WAAW,EAAE,CAAA;QACvC,IAAI,IAAI,GAAG,GAAG,IAAI,EAAE,CAAA;QAEpB,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAA;SAC9B;QAED,OAAO,GAAG,IAAI,IAAI,KAAK,OAAO,EAAE,CAAA;QAEhC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;KAChC;;;;;"}

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

@@ -0,0 +1,23 @@
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}
+/**
+ * The server successfully processed the request, asks that the requester reset
+ * its document view, and is not returning any content.
+ */
+export declare const ResetConnection: CloseEvent;
+/**
+ * Similar to Forbidden, but specifically for use when authentication is required and has
+ * failed or has not yet been provided.
+ */
+export declare const Unauthorized: CloseEvent;
+/**
+ * The request contained valid data and was understood by the server, but the server
+ * is refusing action.
+ */
+export declare const Forbidden: CloseEvent;
+/**
+ * The server timed out waiting for the request.
+ */
+export declare const ConnectionTimeout: CloseEvent;

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

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

package/dist/packages/extension-database/src/Database.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server';
+export interface DatabaseConfiguration {
+    /**
+     * Pass a Promise to retrieve updates from your database. The Promise should resolve to
+     * an array of items with Y.js-compatible binary data.
+     */
+    fetchUpdates: ({ documentName }: {
+        documentName: string;
+    }) => Promise<Uint8Array[]>;
+    /**
+     * Pass a function to store updates in your database.
+     */
+    storeUpdate: ({ update, documentName }: {
+        update: Buffer;
+        documentName: string;
+    }) => void;
+}
+export declare class Database implements Extension {
+    /**
+     * Default configuration
+     */
+    configuration: DatabaseConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration: Partial<DatabaseConfiguration>);
+    /**
+     * Get stored data from the database.
+     */
+    onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any>;
+    /**
+     * Store new updates in the database.
+     */
+    onChange({ document, documentName }: onChangePayload): Promise<void>;
+}

package/dist/packages/extension-database/src/index.d.ts

@@ -0,0 +1 @@
+export * from './Database';

package/dist/packages/extension-logger/src/Logger.d.ts

@@ -1,4 +1,4 @@
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
 export interface LoggerConfiguration {
     /**
      * Prepend all logging message with a string.
@@ -30,10 +30,6 @@ export interface LoggerConfiguration {
      * Whether to log something for the `onRequest` hook.
      */
     onRequest: boolean;
-    /**
-     * Whether to log something for the `onListen` hook.
-     */
-    onListen: boolean;
     /**
      * Whether to log something for the `onDestroy` hook.
      */
@@ -54,15 +50,13 @@ export declare class Logger implements Extension {
      * Constructor
      */
     constructor(configuration?: Partial<LoggerConfiguration>);
+    onConfigure(data: onConfigurePayload): Promise<void>;
     onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;
     onConnect(data: onConnectPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
     onUpgrade(data: onUpgradePayload): Promise<void>;
     onRequest(data: onRequestPayload): Promise<void>;
-    onListen(data: onListenPayload): Promise<void>;
     onDestroy(data: onDestroyPayload): Promise<void>;
-    onConfigure(data: onConfigurePayload): Promise<void>;
-    private logRawText;
     private log;
 }

package/dist/packages/extension-sqlite/src/SQLite.d.ts

@@ -0,0 +1,26 @@
+import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database';
+import sqlite3 from 'sqlite3';
+export interface SQLiteConfiguration extends DatabaseConfiguration {
+    /**
+     * Valid values are filenames, ":memory:" for an anonymous in-memory database and an empty
+     * string for an anonymous disk-based database. Anonymous databases are not persisted and
+     * when closing the database handle, their contents are lost.
+     *
+     * https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback
+     */
+    database: string;
+    /**
+     * The database schema to create.
+     */
+    schema: string;
+}
+export declare class SQLite extends Database {
+    db?: sqlite3.Database;
+    configuration: SQLiteConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<SQLiteConfiguration>);
+    onListen(): Promise<void>;
+    onConfigure(): Promise<void>;
+}

package/dist/packages/extension-sqlite/src/index.d.ts

@@ -0,0 +1 @@
+export * from './SQLite';

package/dist/packages/extension-webhook/src/index.d.ts

@@ -42,7 +42,7 @@ export declare class Webhook implements Extension {
     /**
      * Send a request to the given url containing the given data
      */
-    sendRequest(event: Events, payload: any): Promise<AxiosResponse<unknown, any>>;
+    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any, any>>;
     /**
      * onChange hook
      */

package/dist/packages/provider/src/HocuspocusCloudProvider.d.ts

@@ -0,0 +1,11 @@
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
+export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & AdditionalHocuspocusCloudProviderConfiguration;
+export interface AdditionalHocuspocusCloudProviderConfiguration {
+    /**
+     * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+     */
+    key: string;
+}
+export declare class HocuspocusCloudProvider extends HocuspocusProvider {
+    constructor(configuration: HocuspocusCloudProviderConfiguration);
+}

package/dist/packages/provider/src/HocuspocusProvider.d.ts

@@ -10,7 +10,8 @@ export declare enum WebSocketStatus {
     Connected = "connected",
     Disconnected = "disconnected"
 }
-export interface HocuspocusProviderOptions {
+export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
+export interface CompleteHocuspocusProviderConfiguration {
     /**
      * URL of your @hocuspocus/server instance
      */
@@ -104,9 +105,13 @@ export interface HocuspocusProviderOptions {
     onDestroy: () => void;
     onAwarenessUpdate: (states: any) => void;
     onAwarenessChange: (states: any) => void;
+    /**
+     * Don’t output any warnings.
+     */
+    quiet: boolean;
 }
 export declare class HocuspocusProvider extends EventEmitter {
-    options: HocuspocusProviderOptions;
+    configuration: CompleteHocuspocusProviderConfiguration;
     subscribedToBroadcastChannel: boolean;
     webSocket: WebSocket | null;
     shouldConnect: boolean;
@@ -120,8 +125,8 @@ export declare class HocuspocusProvider extends EventEmitter {
         resolve: (value?: any) => void;
         reject: (reason?: any) => void;
     } | null;
-    constructor(options?: Partial<HocuspocusProviderOptions>);
-    setOptions(options?: Partial<HocuspocusProviderOptions>): void;
+    constructor(configuration: HocuspocusProviderConfiguration);
+    setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
     connect(): Promise<void>;
     createWebSocketConnection(): Promise<unknown>;
     resolveConnectionAttempt(): void;
@@ -130,7 +135,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     get awareness(): Awareness;
     checkConnection(): void;
     forceSync(): void;
-    registerBeforeUnloadEventListener(): void;
+    registerEventListeners(): void;
     documentUpdateHandler(update: Uint8Array, origin: any): void;
     awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
     permissionDeniedHandler(reason: string): void;

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

@@ -1,3 +1,4 @@
 export * from './HocuspocusProvider';
+export * from './HocuspocusCloudProvider';
 export * from './types';
 export * from './utils';

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

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

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

@@ -3,13 +3,15 @@ import WebSocket, { WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
 import { Configuration, Hook } from './types';
 import { MessageLogger } from './Debugger';
+import { onListenPayload } from '.';
 export declare const defaultConfiguration: {
     name: null;
     port: number;
     timeout: number;
+    quiet: boolean;
 };
 /**
- * Hocuspocus server
+ * Hocuspocus Server
  */
 export declare class Hocuspocus {
     configuration: Configuration;
@@ -21,11 +23,12 @@ export declare class Hocuspocus {
      * Configure the server
      */
     configure(configuration: Partial<Configuration>): Hocuspocus;
-    get authenticationRequired(): boolean;
+    get requiresAuthentication(): boolean;
     /**
      * Start the server
      */
-    listen(): Promise<void>;
+    listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any): Promise<void>;
+    private showStartScreen;
     /**
      * Get the total number of active documents
      */
@@ -43,7 +46,14 @@ export declare class Hocuspocus {
      */
     destroy(): Promise<any>;
     /**
-     * Handle the incoming WebSocket connection
+     * The `handleConnection` method receives incoming WebSocket connections,
+     * runs all hooks:
+     *
+     *  - onConnect for all connections
+     *  - onAuthenticate only if required
+     *
+     * … and if nothings fails it’ll fully establish the connection and
+     * load the Document then.
      */
     handleConnection(incoming: WebSocket, request: IncomingMessage, documentName: string, context?: any): void;
     /**

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

@@ -25,8 +25,9 @@ export interface AwarenessUpdate {
     updated: Array<any>;
     removed: Array<any>;
 }
-export interface ConnectionConfig {
+export interface ConnectionConfiguration {
     readOnly: boolean;
+    requiresAuthentication: boolean;
     isAuthenticated: boolean;
 }
 export interface Extension {
@@ -67,6 +68,10 @@ export interface Configuration extends Extension {
      * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
      */
     timeout: number;
+    /**
+     * By default, the servers show a start screen. If passed false, the server will start quietly.
+     */
+    quiet: boolean;
     /**
      * Function which returns the (customized) document name based on the request
      */
@@ -83,7 +88,7 @@ export interface onAuthenticatePayload {
     requestParameters: URLSearchParams;
     socketId: string;
     token: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     documentName: string;
@@ -92,7 +97,7 @@ export interface onConnectPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onLoadDocumentPayload {
     context: any;
@@ -102,7 +107,7 @@ export interface onLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
@@ -148,7 +153,3 @@ export interface onConfigurePayload {
     yjsVersion: string;
     instance: Hocuspocus;
 }
-export interface CloseEvent {
-    code: number;
-    reason: string;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-logger",
-  "version": "1.0.0-alpha.59",
+  "version": "1.0.0-alpha.63",
   "description": "hocuspocus logging extension",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,7 +28,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^1.0.0-alpha.85"
+    "@hocuspocus/server": "^1.0.0-alpha.89"
   },
-  "gitHead": "63a50dd02286693b5025ac385c3fb4afd6b29050"
+  "gitHead": "87b715d1d28c603702879f4413c17d2c4a38c51a"
 }

package/src/Logger.ts

@@ -6,7 +6,6 @@ import {
   onLoadDocumentPayload,
   onDestroyPayload,
   onDisconnectPayload,
-  onListenPayload,
   onRequestPayload,
   onUpgradePayload,
 } from '@hocuspocus/server'
@@ -42,10 +41,6 @@ export interface LoggerConfiguration {
    * Whether to log something for the `onRequest` hook.
    */
   onRequest: boolean,
-  /**
-   * Whether to log something for the `onListen` hook.
-   */
-  onListen: boolean,
   /**
    * Whether to log something for the `onDestroy` hook.
    */
@@ -71,7 +66,6 @@ export class Logger implements Extension {
     onDisconnect: true,
     onUpgrade: true,
     onRequest: true,
-    onListen: true,
     onDestroy: true,
     onConfigure: true,
     log: console.log, // eslint-disable-line
@@ -87,6 +81,18 @@ export class Logger implements Extension {
     }
   }
 
+  async onConfigure(data: onConfigurePayload) {
+    this.name = data.instance.configuration.name
+
+    if (!this.configuration.onConfigure) {
+      return
+    }
+
+    if (this.configuration.prefix) {
+      console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.')
+    }
+  }
+
   async onLoadDocument(data: onLoadDocumentPayload) {
     if (this.configuration.onLoadDocument) {
       this.log(`Loaded document "${data.documentName}".`)
@@ -123,73 +129,23 @@ export class Logger implements Extension {
     }
   }
 
-  async onListen(data: onListenPayload) {
-    if (this.configuration.onListen) {
-      this.logRawText('Ready.')
-      this.logRawText()
-    }
-  }
-
   async onDestroy(data: onDestroyPayload) {
     if (this.configuration.onDestroy) {
       this.log('Shut down.')
     }
   }
 
-  async onConfigure(data: onConfigurePayload) {
-    if (!this.configuration.onConfigure) {
-      return
-    }
-
-    if (this.configuration.prefix) {
-      console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.')
-    }
-
-    this.name = data.instance.configuration.name
-
-    this.logRawText()
-    this.logRawText(`Hocuspocus v${data.version} running at:`)
-    this.logRawText()
-    this.logRawText(`> HTTP: http://127.0.0.1:${data.configuration.port}`)
-    this.logRawText(`> WebSocket: ws://127.0.0.1:${data.configuration.port}`)
-
-    const { instance } = data
-
-    const extensions = instance.configuration?.extensions.map(extension => {
-      return extension.constructor?.name
-    })
-      .filter(name => name)
-      .filter(name => name !== 'Object')
+  private log(message: string) {
+    const date = (new Date()).toISOString()
+    let meta = `${date}`
 
-    if (!extensions.length) {
-      return
+    if (this.name) {
+      meta = `${this.name} ${meta}`
     }
 
-    this.logRawText()
-    this.logRawText('Extensions:')
+    message = `[${meta}] ${message}`
 
-    extensions
-      .forEach(name => {
-        this.logRawText(`- ${name}`)
-      })
-
-    this.logRawText()
-  }
-
-  private logRawText(message = '') {
     this.configuration.log(message)
   }
 
-  private log(message: string) {
-    message = `[${(new Date()).toISOString()}] ${message}`
-
-    const name = this.name ? this.name : this.configuration.prefix
-
-    if (name) {
-      message = `[${name}] ${message}`
-    }
-
-    this.logRawText(message)
-  }
-
 }

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

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