@hocuspocus/extension-throttle 1.0.0-alpha.9 → 1.0.0-beta.2

package/dist/{hocuspocus-throttle.js → hocuspocus-throttle.cjs}

@@ -3,13 +3,20 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 class Throttle {
-    constructor() {
+    /**
+     * Constructor
+     */
+    constructor(configuration) {
         this.configuration = {
             throttle: 15,
             banTime: 5,
         };
         this.connectionsByIp = new Map();
         this.bannedIps = new Map();
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
     }
     /**
      * Throttle requests
@@ -51,23 +58,7 @@ class Throttle {
         // throttle the connection
         return this.throttle(ip) ? Promise.reject() : Promise.resolve();
     }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onCreateDocument(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onChange(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onDisconnect(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onUpgrade(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onRequest(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onListen(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onDestroy(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onConfigure(data) { }
 }
 
 exports.Throttle = Throttle;
-//# sourceMappingURL=hocuspocus-throttle.js.map
+//# sourceMappingURL=hocuspocus-throttle.cjs.map

package/dist/hocuspocus-throttle.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"hocuspocus-throttle.cjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  Extension,\n  onConnectPayload,\n} from '@hocuspocus/server'\n\nexport interface ThrottleConfiguration {\n  throttle: number | null | false,\n  banTime: number,\n}\n\nexport class Throttle implements Extension {\n\n  configuration: ThrottleConfiguration = {\n    throttle: 15,\n    banTime: 5,\n  }\n\n  connectionsByIp: Map<string, Array<number>> = new Map()\n\n  bannedIps: Map<string, number> = new Map()\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<ThrottleConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Throttle requests\n   * @private\n   */\n  private throttle(ip: string): Boolean {\n    if (!this.configuration.throttle) {\n      return false\n    }\n\n    const bannedAt = this.bannedIps.get(ip) || 0\n\n    if (Date.now() < (bannedAt + (this.configuration.banTime * 60 * 1000))) {\n      return true\n    }\n\n    this.bannedIps.delete(ip)\n\n    // add this connection try to the list of previous connections\n    const previousConnections = this.connectionsByIp.get(ip) || []\n    previousConnections.push(Date.now())\n\n    // calculate the previous connections in the last minute\n    const previousConnectionsInTheLastMinute = previousConnections\n      .filter(timestamp => timestamp + (60 * 1000) > Date.now())\n\n    this.connectionsByIp.set(ip, previousConnectionsInTheLastMinute)\n\n    if (previousConnectionsInTheLastMinute.length > this.configuration.throttle) {\n      this.bannedIps.set(ip, Date.now())\n      return true\n    }\n\n    return false\n  }\n\n  /**\n   * onConnect hook\n   * @param data\n   */\n  onConnect(data: onConnectPayload): Promise<any> {\n    const { request } = data\n\n    // get the remote ip address\n    const ip = request.headers['x-real-ip']\n      || request.headers['x-forwarded-for']\n      || request.socket.remoteAddress\n      || ''\n\n    // throttle the connection\n    return this.throttle(<string> ip) ? Promise.reject() : Promise.resolve()\n  }\n\n}\n"],"names":[],"mappings":";;;;MAUa,QAAQ,CAAA;AAWnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA8C,EAAA;AAZ1D,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,QAAQ,EAAE,EAAE;AACZ,YAAA,OAAO,EAAE,CAAC;SACX,CAAA;AAED,QAAA,IAAA,CAAA,eAAe,GAA+B,IAAI,GAAG,EAAE,CAAA;AAEvD,QAAA,IAAA,CAAA,SAAS,GAAwB,IAAI,GAAG,EAAE,CAAA;QAMxC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;;AAGG;AACK,IAAA,QAAQ,CAAC,EAAU,EAAA;AACzB,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAA,OAAO,KAAK,CAAA;AACb,SAAA;AAED,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;QAE5C,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE;AACtE,YAAA,OAAO,IAAI,CAAA;AACZ,SAAA;AAED,QAAA,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;;AAGzB,QAAA,MAAM,mBAAmB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,CAAA;QAC9D,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;;QAGpC,MAAM,kCAAkC,GAAG,mBAAmB;AAC3D,aAAA,MAAM,CAAC,SAAS,IAAI,SAAS,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;QAE5D,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,EAAE,kCAAkC,CAAC,CAAA;QAEhE,IAAI,kCAAkC,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;AAC3E,YAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;AAClC,YAAA,OAAO,IAAI,CAAA;AACZ,SAAA;AAED,QAAA,OAAO,KAAK,CAAA;KACb;AAED;;;AAGG;AACH,IAAA,SAAS,CAAC,IAAsB,EAAA;AAC9B,QAAA,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;;AAGxB,QAAA,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;AAClC,eAAA,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;eAClC,OAAO,CAAC,MAAM,CAAC,aAAa;AAC5B,eAAA,EAAE,CAAA;;QAGP,OAAO,IAAI,CAAC,QAAQ,CAAU,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAA;KACzE;AAEF;;;;"}

package/dist/hocuspocus-throttle.esm.js

@@ -1,11 +1,18 @@
 class Throttle {
-    constructor() {
+    /**
+     * Constructor
+     */
+    constructor(configuration) {
         this.configuration = {
             throttle: 15,
             banTime: 5,
         };
         this.connectionsByIp = new Map();
         this.bannedIps = new Map();
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
     }
     /**
      * Throttle requests
@@ -47,22 +54,6 @@ class Throttle {
         // throttle the connection
         return this.throttle(ip) ? Promise.reject() : Promise.resolve();
     }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onCreateDocument(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onChange(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onDisconnect(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onUpgrade(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onRequest(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onListen(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onDestroy(data) { }
-    // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function
-    async onConfigure(data) { }
 }
 
 export { Throttle };

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

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-throttle.esm.js","sources":["../src/index.ts"],"sourcesContent":["import {\n  Extension,\n  onChangePayload,\n  onConfigurePayload,\n  onConnectPayload,\n  onCreateDocumentPayload,\n  onDestroyPayload,\n  onDisconnectPayload,\n  onListenPayload,\n  onRequestPayload,\n  onUpgradePayload,\n} from '@hocuspocus/server'\n\nexport interface Configuration {\n  throttle: number | null | false,\n  banTime: number,\n}\n\nexport class Throttle implements Extension {\n\n  configuration: Configuration = {\n    throttle: 15,\n    banTime: 5,\n  }\n\n  connectionsByIp: Map<string, Array<number>> = new Map()\n\n  bannedIps: Map<string, number> = new Map()\n\n  /**\n   * Throttle requests\n   * @private\n   */\n  private throttle(ip: string): Boolean {\n    if (!this.configuration.throttle) {\n      return false\n    }\n\n    const bannedAt = this.bannedIps.get(ip) || 0\n\n    if (Date.now() < (bannedAt + (this.configuration.banTime * 60 * 1000))) {\n      return true\n    }\n\n    this.bannedIps.delete(ip)\n\n    // add this connection try to the list of previous connections\n    const previousConnections = this.connectionsByIp.get(ip) || []\n    previousConnections.push(Date.now())\n\n    // calculate the previous connections in the last minute\n    const previousConnectionsInTheLastMinute = previousConnections\n      .filter(timestamp => timestamp + (60 * 1000) > Date.now())\n\n    this.connectionsByIp.set(ip, previousConnectionsInTheLastMinute)\n\n    if (previousConnectionsInTheLastMinute.length > this.configuration.throttle) {\n      this.bannedIps.set(ip, Date.now())\n      return true\n    }\n\n    return false\n  }\n\n  /**\n   * onConnect hook\n   * @param data\n   */\n  onConnect(data: onConnectPayload): Promise<any> {\n    const { request } = data\n\n    // get the remote ip address\n    const ip = request.headers['x-real-ip']\n      || request.headers['x-forwarded-for']\n      || request.socket.remoteAddress\n      || ''\n\n    // throttle the connection\n    return this.throttle(<string> ip) ? Promise.reject() : Promise.resolve()\n  }\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onCreateDocument(data: onCreateDocumentPayload) {}\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onChange(data: onChangePayload) {}\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onDisconnect(data: onDisconnectPayload) {}\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onUpgrade(data: onUpgradePayload) {}\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onRequest(data: onRequestPayload) {}\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onListen(data: onListenPayload) {}\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onDestroy(data: onDestroyPayload) {}\n\n  // eslint-disable-next-line no-empty-function,@typescript-eslint/no-empty-function\n  async onConfigure(data: onConfigurePayload) {}\n}\n"],"names":[],"mappings":"MAkBa,QAAQ;IAArB;QAEE,kBAAa,GAAkB;YAC7B,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,CAAC;SACX,CAAA;QAED,oBAAe,GAA+B,IAAI,GAAG,EAAE,CAAA;QAEvD,cAAS,GAAwB,IAAI,GAAG,EAAE,CAAA;KA6E3C;;;;;IAvES,QAAQ,CAAC,EAAU;QACzB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAChC,OAAO,KAAK,CAAA;SACb;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;QAE5C,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE;YACtE,OAAO,IAAI,CAAA;SACZ;QAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;;QAGzB,MAAM,mBAAmB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,CAAA;QAC9D,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;;QAGpC,MAAM,kCAAkC,GAAG,mBAAmB;aAC3D,MAAM,CAAC,SAAS,IAAI,SAAS,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;QAE5D,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,EAAE,kCAAkC,CAAC,CAAA;QAEhE,IAAI,kCAAkC,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;YAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;YAClC,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,KAAK,CAAA;KACb;;;;;IAMD,SAAS,CAAC,IAAsB;QAC9B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;;QAGxB,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;eAClC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;eAClC,OAAO,CAAC,MAAM,CAAC,aAAa;eAC5B,EAAE,CAAA;;QAGP,OAAO,IAAI,CAAC,QAAQ,CAAU,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAA;KACzE;;IAGD,MAAM,gBAAgB,CAAC,IAA6B,KAAI;;IAGxD,MAAM,QAAQ,CAAC,IAAqB,KAAI;;IAGxC,MAAM,YAAY,CAAC,IAAyB,KAAI;;IAGhD,MAAM,SAAS,CAAC,IAAsB,KAAI;;IAG1C,MAAM,SAAS,CAAC,IAAsB,KAAI;;IAG1C,MAAM,QAAQ,CAAC,IAAqB,KAAI;;IAGxC,MAAM,SAAS,CAAC,IAAsB,KAAI;;IAG1C,MAAM,WAAW,CAAC,IAAwB,KAAI;;;;;"}
+{"version":3,"file":"hocuspocus-throttle.esm.js","sources":["../src/index.ts"],"sourcesContent":["import {\n  Extension,\n  onConnectPayload,\n} from '@hocuspocus/server'\n\nexport interface ThrottleConfiguration {\n  throttle: number | null | false,\n  banTime: number,\n}\n\nexport class Throttle implements Extension {\n\n  configuration: ThrottleConfiguration = {\n    throttle: 15,\n    banTime: 5,\n  }\n\n  connectionsByIp: Map<string, Array<number>> = new Map()\n\n  bannedIps: Map<string, number> = new Map()\n\n  /**\n   * Constructor\n   */\n  constructor(configuration?: Partial<ThrottleConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Throttle requests\n   * @private\n   */\n  private throttle(ip: string): Boolean {\n    if (!this.configuration.throttle) {\n      return false\n    }\n\n    const bannedAt = this.bannedIps.get(ip) || 0\n\n    if (Date.now() < (bannedAt + (this.configuration.banTime * 60 * 1000))) {\n      return true\n    }\n\n    this.bannedIps.delete(ip)\n\n    // add this connection try to the list of previous connections\n    const previousConnections = this.connectionsByIp.get(ip) || []\n    previousConnections.push(Date.now())\n\n    // calculate the previous connections in the last minute\n    const previousConnectionsInTheLastMinute = previousConnections\n      .filter(timestamp => timestamp + (60 * 1000) > Date.now())\n\n    this.connectionsByIp.set(ip, previousConnectionsInTheLastMinute)\n\n    if (previousConnectionsInTheLastMinute.length > this.configuration.throttle) {\n      this.bannedIps.set(ip, Date.now())\n      return true\n    }\n\n    return false\n  }\n\n  /**\n   * onConnect hook\n   * @param data\n   */\n  onConnect(data: onConnectPayload): Promise<any> {\n    const { request } = data\n\n    // get the remote ip address\n    const ip = request.headers['x-real-ip']\n      || request.headers['x-forwarded-for']\n      || request.socket.remoteAddress\n      || ''\n\n    // throttle the connection\n    return this.throttle(<string> ip) ? Promise.reject() : Promise.resolve()\n  }\n\n}\n"],"names":[],"mappings":"MAUa,QAAQ,CAAA;AAWnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA8C,EAAA;AAZ1D,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,QAAQ,EAAE,EAAE;AACZ,YAAA,OAAO,EAAE,CAAC;SACX,CAAA;AAED,QAAA,IAAA,CAAA,eAAe,GAA+B,IAAI,GAAG,EAAE,CAAA;AAEvD,QAAA,IAAA,CAAA,SAAS,GAAwB,IAAI,GAAG,EAAE,CAAA;QAMxC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;;AAGG;AACK,IAAA,QAAQ,CAAC,EAAU,EAAA;AACzB,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAA,OAAO,KAAK,CAAA;AACb,SAAA;AAED,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;QAE5C,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE;AACtE,YAAA,OAAO,IAAI,CAAA;AACZ,SAAA;AAED,QAAA,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;;AAGzB,QAAA,MAAM,mBAAmB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,CAAA;QAC9D,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;;QAGpC,MAAM,kCAAkC,GAAG,mBAAmB;AAC3D,aAAA,MAAM,CAAC,SAAS,IAAI,SAAS,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;QAE5D,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,EAAE,kCAAkC,CAAC,CAAA;QAEhE,IAAI,kCAAkC,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;AAC3E,YAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;AAClC,YAAA,OAAO,IAAI,CAAA;AACZ,SAAA;AAED,QAAA,OAAO,KAAK,CAAA;KACb;AAED;;;AAGG;AACH,IAAA,SAAS,CAAC,IAAsB,EAAA;AAC9B,QAAA,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;;AAGxB,QAAA,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;AAClC,eAAA,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;eAClC,OAAO,CAAC,MAAM,CAAC,aAAa;AAC5B,eAAA,EAAE,CAAA;;QAGP,OAAO,IAAI,CAAC,QAAQ,CAAU,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAA;KACzE;AAEF;;;;"}

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/auth.d.ts

@@ -0,0 +1,6 @@
+import * as encoding from 'lib0/encoding';
+import * as decoding from 'lib0/decoding';
+export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
+export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
+export declare const writeAuthenticated: (encoder: encoding.Encoder) => void;
+export declare const readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: () => void) => void;

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

@@ -0,0 +1,3 @@
+export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
+    clientId: number;
+}[];

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

@@ -0,0 +1,4 @@
+export * from './auth';
+export * from './CloseEvents';
+export * from './awarenessStatesToArray';
+export * from './types';

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

@@ -0,0 +1,10 @@
+/**
+ * State of the WebSocket connection.
+ * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
+ */
+export declare enum WsReadyStates {
+    Connecting = 0,
+    Open = 1,
+    Closing = 2,
+    Closed = 3
+}

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

@@ -0,0 +1,30 @@
+import { Extension, onChangePayload, onLoadDocumentPayload, storePayload, fetchPayload } 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.
+     */
+    fetch: (data: fetchPayload) => Promise<Uint8Array | null>;
+    /**
+     * Pass a function to store updates in your database.
+     */
+    store: (data: storePayload) => void;
+}
+export declare class Database implements Extension {
+    /**
+     * Default configuration
+     */
+    configuration: DatabaseConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration: Partial<DatabaseConfiguration>);
+    /**
+     * Get stored data from the database.
+     */
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
+    /**
+     * Store new updates in the database.
+     */
+    onStoreDocument(data: 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

@@ -0,0 +1,67 @@
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+export interface LoggerConfiguration {
+    /**
+     * Prepend all logging message with a string.
+     *
+     * @deprecated
+     */
+    prefix: null | string;
+    /**
+     * Whether to log something for the `onLoadDocument` hook.
+     */
+    onLoadDocument: boolean;
+    /**
+     * Whether to log something for the `onChange` hook.
+     */
+    onChange: boolean;
+    /**
+     * Whether to log something for the `onStoreDocument` hook.
+     */
+    onStoreDocument: boolean;
+    /**
+     * Whether to log something for the `onConnect` hook.
+     */
+    onConnect: boolean;
+    /**
+     * Whether to log something for the `onDisconnect` hook.
+     */
+    onDisconnect: boolean;
+    /**
+     * Whether to log something for the `onUpgrade` hook.
+     */
+    onUpgrade: boolean;
+    /**
+     * Whether to log something for the `onRequest` hook.
+     */
+    onRequest: boolean;
+    /**
+     * Whether to log something for the `onDestroy` hook.
+     */
+    onDestroy: boolean;
+    /**
+     * Whether to log something for the `onConfigure` hook.
+     */
+    onConfigure: boolean;
+    /**
+     * A log function, if none is provided output will go to console
+     */
+    log: (...args: any[]) => void;
+}
+export declare class Logger implements Extension {
+    name: string | null;
+    configuration: LoggerConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<LoggerConfiguration>);
+    onConfigure(data: onConfigurePayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
+    onChange(data: onChangePayload): Promise<void>;
+    onStoreDocument(data: onDisconnectPayload): Promise<void>;
+    onConnect(data: onConnectPayload): Promise<void>;
+    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onUpgrade(data: onUpgradePayload): Promise<void>;
+    onRequest(data: onRequestPayload): Promise<void>;
+    onDestroy(data: onDestroyPayload): Promise<void>;
+    private log;
+}

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

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

package/dist/packages/{monitor → extension-monitor}/src/Collector.d.ts

@@ -1,9 +1,8 @@
 /// <reference types="node" />
-import { Configuration, onConnectPayload, onDisconnectPayload, onCreateDocumentPayload, onChangePayload } from '@hocuspocus/server';
+import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPayload, onChangePayload } from '@hocuspocus/server';
 export declare class Collector {
     serverConfiguration: Partial<Configuration>;
     version: string;
-    yjsVersion: string;
     connections: {};
     messages: {};
     messageCounter: number;
@@ -30,7 +29,7 @@ export declare class Collector {
     connectionCount(): {
         count: string | number;
     };
-    createDocument(data: onCreateDocumentPayload): {
+    createDocument(data: onLoadDocumentPayload): {
         action: string;
         document: any;
         documentName: string;
@@ -51,12 +50,12 @@ export declare class Collector {
     documents(): {};
     info(): Promise<{
         configuration: Partial<Configuration>;
-        ipAddress: string;
+        ipAddress: string | null;
         nodeVersion: string;
         platform: NodeJS.Platform;
         started: string;
         version: string;
-        yjsVersion: string;
     }>;
+    private getIpAddress;
     private static readableYDoc;
 }

package/dist/packages/{monitor → extension-monitor}/src/Dashboard.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { IncomingMessage, ServerResponse } from 'http';
-import WebSocket from 'ws';
+import WebSocket, { WebSocketServer } from 'ws';
 import { Socket } from 'net';
 import { Storage } from './Storage';
 export interface Configuration {
@@ -12,7 +12,7 @@ export interface Configuration {
 }
 export declare class Dashboard {
     configuration: Configuration;
-    websocketServer: WebSocket.Server;
+    websocketServer: WebSocketServer;
     connections: Map<WebSocket, any>;
     /**
      * Constructor

package/dist/packages/{monitor → extension-monitor}/src/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onCreateDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload, connectedPayload } from '@hocuspocus/server';
 import { IncomingMessage, ServerResponse } from 'http';
 import WebSocket from 'ws';
 import { Storage } from './Storage';
@@ -30,11 +30,9 @@ export declare class Monitor implements Extension {
     handleConnection(websocket: WebSocket, request: IncomingMessage): void | undefined;
     onRequest({ request, response }: onRequestPayload): Promise<void>;
     onUpgrade({ request, socket, head }: onUpgradePayload): Promise<void>;
-    onConnect(data: onConnectPayload): Promise<void>;
+    connected(data: connectedPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;
-    onListen(data: onListenPayload): Promise<void>;
-    onDestroy(data: onDestroyPayload): Promise<void>;
     onConfigure(data: onConfigurePayload): Promise<void>;
 }

package/dist/packages/extension-redis/src/Redis.d.ts

@@ -0,0 +1,98 @@
+import RedisClient from 'ioredis';
+import Redlock from 'redlock';
+import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, onListenPayload } from '@hocuspocus/server';
+export interface Configuration {
+    /**
+     * Redis port
+     */
+    port: number;
+    /**
+     * Redis host
+     */
+    host: string;
+    /**
+     * Options passed directly to Redis constructor
+     *
+     * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
+     */
+    options?: RedisClient.RedisOptions;
+    /**
+     * An unique instance name, required to filter messages in Redis.
+     * If none is provided an unique id is generated.
+     */
+    identifier: string;
+    /**
+     * Namespace for Redis keys, if none is provided 'hocuspocus' is used
+     */
+    prefix: string;
+    /**
+     * The maximum time for the Redis lock in ms (in case it can’t be released).
+     */
+    lockTimeout: number;
+}
+export declare class Redis implements Extension {
+    /**
+     * Make sure to give that extension a higher priority, so
+     * the `onStoreDocument` hook is able to intercept the chain,
+     * before documents are stored to the database.
+     */
+    priority: number;
+    configuration: Configuration;
+    pub: RedisClient.Redis;
+    sub: RedisClient.Redis;
+    documents: Map<string, Document>;
+    redlock: Redlock;
+    locks: Map<string, Redlock.Lock>;
+    logger: Debugger;
+    constructor(configuration: Partial<Configuration>);
+    onConfigure({ instance }: onConfigurePayload): Promise<void>;
+    onListen({ configuration }: onListenPayload): Promise<void>;
+    private getKey;
+    private pubKey;
+    private subKey;
+    private lockKey;
+    /**
+     * Once a document is laoded, subscribe to the channel in Redis.
+     */
+    afterLoadDocument({ documentName, document }: afterLoadDocumentPayload): Promise<unknown>;
+    /**
+     * Publish the first sync step through Redis.
+     */
+    private publishFirstSyncStep;
+    /**
+     * Let’s ask Redis who is connected already.
+     */
+    private requestAwarenessFromOtherInstances;
+    /**
+     * Before the document is stored, make sure to set a lock in Redis.
+     * That’s meant to avoid conflicts with other instances trying to store the document.
+     */
+    onStoreDocument({ documentName }: onStoreDocumentPayload): Promise<unknown>;
+    /**
+     * Release the Redis lock, so other instances can store documents.
+     */
+    afterStoreDocument({ documentName }: afterStoreDocumentPayload): Promise<void>;
+    /**
+     * Handle awareness update messages received directly by this Hocuspocus instance.
+     */
+    onAwarenessUpdate({ documentName, awareness, added, updated, removed, }: onAwarenessUpdatePayload): Promise<number>;
+    /**
+     * Handle incoming messages published on all subscribed document channels.
+     * Note that this will also include messages from ourselves as it is not possible
+     * in Redis to filter these.
+    */
+    private handleIncomingMessage;
+    /**
+     * if the ydoc changed, we'll need to inform other Hocuspocus servers about it.
+     */
+    onChange(data: onChangePayload): Promise<any>;
+    /**
+     * Make sure to *not* listen for further changes, when there’s
+     * noone connected anymore.
+     */
+    onDisconnect: ({ documentName, clientsCount }: onDisconnectPayload) => Promise<void>;
+    /**
+     * Kill the Redlock connection immediately.
+     */
+    onDestroy(): Promise<void>;
+}

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

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

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 declare const schema = "CREATE TABLE IF NOT EXISTS \"documents\" (\n  \"name\" varchar(255) NOT NULL,\n  \"data\" blob NOT NULL,\n  UNIQUE(name)\n)";
+export declare const selectQuery = "\n  SELECT data FROM \"documents\" WHERE name = $name ORDER BY rowid DESC\n";
+export declare const upsertQuery = "\n  INSERT INTO \"documents\" (\"name\", \"data\") VALUES ($name, $data)\n    ON CONFLICT(name) DO UPDATE SET data = $data\n";
+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(configuration?: Partial<SQLiteConfiguration>);
+    onConfigure(): Promise<void>;
+    onListen(): Promise<void>;
+}

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

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

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

@@ -0,0 +1,24 @@
+import { Extension, onConnectPayload } from '@hocuspocus/server';
+export interface ThrottleConfiguration {
+    throttle: number | null | false;
+    banTime: number;
+}
+export declare class Throttle implements Extension {
+    configuration: ThrottleConfiguration;
+    connectionsByIp: Map<string, Array<number>>;
+    bannedIps: Map<string, number>;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<ThrottleConfiguration>);
+    /**
+     * Throttle requests
+     * @private
+     */
+    private throttle;
+    /**
+     * onConnect hook
+     * @param data
+     */
+    onConnect(data: onConnectPayload): Promise<any>;
+}

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

@@ -1,9 +1,8 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onCreateDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
 import { Doc } from 'yjs';
 import { Transformer } from '@hocuspocus/transformer';
 import { AxiosResponse } from 'axios';
-import Timeout = NodeJS.Timeout;
 export declare enum Events {
     onChange = "change",
     onConnect = "connect",
@@ -24,7 +23,7 @@ export interface Configuration {
 export declare class Webhook implements Extension {
     configuration: Configuration;
     debounced: Map<string, {
-        timeout: Timeout;
+        timeout: NodeJS.Timeout;
         start: number;
     }>;
     /**
@@ -42,23 +41,18 @@ export declare class Webhook implements Extension {
     /**
      * Send a request to the given url containing the given data
      */
-    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any>>;
+    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any, any>>;
     /**
      * onChange hook
      */
     onChange(data: onChangePayload): Promise<void>;
     /**
-     * onCreateDocument hook
+     * onLoadDocument hook
      */
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     /**
      * onConnect hook
      */
     onConnect(data: onConnectPayload): Promise<any>;
     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>;
 }

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

@@ -0,0 +1,9 @@
+export default class EventEmitter {
+    callbacks: {
+        [key: string]: Function[];
+    };
+    on(event: string, fn: Function): this;
+    protected emit(event: string, ...args: any): this;
+    off(event: string, fn?: Function): this;
+    removeAllListeners(): void;
+}

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);
+}