@hocuspocus/extension-database 1.0.0-alpha.13 → 1.0.0-alpha.16

package/dist/hocuspocus-database.cjs

@@ -44,12 +44,12 @@ class Database {
     /**
      * Get stored data from the database.
      */
-    async onLoadDocument({ document, documentName }) {
-        const update = await this.configuration.fetch({ documentName });
+    async onLoadDocument(data) {
+        const update = await this.configuration.fetch(data);
         if (update) {
-            Y__namespace.applyUpdate(document, update);
+            Y__namespace.applyUpdate(data.document, update);
         }
-        return document;
+        return data.document;
     }
     /**
      * Store new updates in the database.

package/dist/hocuspocus-database.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-database.cjs","sources":["../src/Database.ts"],"sourcesContent":["import {\n  Extension, onChangePayload, onLoadDocumentPayload, storePayload,\n} from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetch: ({ documentName }: { documentName: string}) => Promise<Uint8Array | null>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  store: (data: storePayload) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetch: async () => null,\n    store: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch({ documentName })\n\n    if (update) {\n      Y.applyUpdate(document, update)\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onStoreDocument(data: onChangePayload) {\n    return this.configuration.store({\n      ...data,\n      state: Buffer.from(\n        Y.encodeStateAsUpdate(data.document),\n      ),\n    })\n  }\n}\n"],"names":["Y"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;MAiBa,QAAQ,CAAA;AASnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA6C,EAAA;AAXzD;;AAEG;AACH,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,KAAK,EAAE,YAAY,IAAI;AACvB,YAAA,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;AAEG;AACH,IAAA,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB,EAAA;AACpE,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;AAE/D,QAAA,IAAI,MAAM,EAAE;AACV,YAAAA,YAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;AAChC,SAAA;AAED,QAAA,OAAO,QAAQ,CAAA;KAChB;AAED;;AAEG;IACH,MAAM,eAAe,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;AAC9B,YAAA,GAAG,IAAI;AACP,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAChBA,YAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;AACF,SAAA,CAAC,CAAA;KACH;AACF;;;;"}
+{"version":3,"file":"hocuspocus-database.cjs","sources":["../src/Database.ts"],"sourcesContent":["import {\n  Extension,\n  onChangePayload,\n  onLoadDocumentPayload,\n  storePayload,\n  fetchPayload,\n} from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetch: (data: fetchPayload) => Promise<Uint8Array | null>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  store: (data: storePayload) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetch: async () => null,\n    store: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument(data: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch(data)\n\n    if (update) {\n      Y.applyUpdate(data.document, update)\n    }\n\n    return data.document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onStoreDocument(data: onChangePayload) {\n    return this.configuration.store({\n      ...data,\n      state: Buffer.from(\n        Y.encodeStateAsUpdate(data.document),\n      ),\n    })\n  }\n}\n"],"names":["Y"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;MAqBa,QAAQ,CAAA;AASnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA6C,EAAA;AAXzD;;AAEG;AACH,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,KAAK,EAAE,YAAY,IAAI;AACvB,YAAA,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;AAEG;IACH,MAAM,cAAc,CAAC,IAA2B,EAAA;QAC9C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAEnD,QAAA,IAAI,MAAM,EAAE;YACVA,YAAC,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;AACrC,SAAA;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;AAED;;AAEG;IACH,MAAM,eAAe,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;AAC9B,YAAA,GAAG,IAAI;AACP,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAChBA,YAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;AACF,SAAA,CAAC,CAAA;KACH;AACF;;;;"}

package/dist/hocuspocus-database.esm.js

@@ -20,12 +20,12 @@ class Database {
     /**
      * Get stored data from the database.
      */
-    async onLoadDocument({ document, documentName }) {
-        const update = await this.configuration.fetch({ documentName });
+    async onLoadDocument(data) {
+        const update = await this.configuration.fetch(data);
         if (update) {
-            Y.applyUpdate(document, update);
+            Y.applyUpdate(data.document, update);
         }
-        return document;
+        return data.document;
     }
     /**
      * Store new updates in the database.

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

@@ -1 +1 @@
-{"version":3,"file":"hocuspocus-database.esm.js","sources":["../src/Database.ts"],"sourcesContent":["import {\n  Extension, onChangePayload, onLoadDocumentPayload, storePayload,\n} from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetch: ({ documentName }: { documentName: string}) => Promise<Uint8Array | null>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  store: (data: storePayload) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetch: async () => null,\n    store: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch({ documentName })\n\n    if (update) {\n      Y.applyUpdate(document, update)\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onStoreDocument(data: onChangePayload) {\n    return this.configuration.store({\n      ...data,\n      state: Buffer.from(\n        Y.encodeStateAsUpdate(data.document),\n      ),\n    })\n  }\n}\n"],"names":[],"mappings":";;MAiBa,QAAQ,CAAA;AASnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA6C,EAAA;AAXzD;;AAEG;AACH,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,KAAK,EAAE,YAAY,IAAI;AACvB,YAAA,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;AAEG;AACH,IAAA,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB,EAAA;AACpE,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;AAE/D,QAAA,IAAI,MAAM,EAAE;AACV,YAAA,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;AAChC,SAAA;AAED,QAAA,OAAO,QAAQ,CAAA;KAChB;AAED;;AAEG;IACH,MAAM,eAAe,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;AAC9B,YAAA,GAAG,IAAI;AACP,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAChB,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;AACF,SAAA,CAAC,CAAA;KACH;AACF;;;;"}
+{"version":3,"file":"hocuspocus-database.esm.js","sources":["../src/Database.ts"],"sourcesContent":["import {\n  Extension,\n  onChangePayload,\n  onLoadDocumentPayload,\n  storePayload,\n  fetchPayload,\n} from '@hocuspocus/server'\nimport * as Y from 'yjs'\n\nexport interface DatabaseConfiguration {\n  /**\n   * Pass a Promise to retrieve updates from your database. The Promise should resolve to\n   * an array of items with Y.js-compatible binary data.\n   */\n  fetch: (data: fetchPayload) => Promise<Uint8Array | null>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  store: (data: storePayload) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetch: async () => null,\n    store: async () => null,\n  }\n\n  /**\n   * Constructor\n   */\n  constructor(configuration: Partial<DatabaseConfiguration>) {\n    this.configuration = {\n      ...this.configuration,\n      ...configuration,\n    }\n  }\n\n  /**\n   * Get stored data from the database.\n   */\n  async onLoadDocument(data: onLoadDocumentPayload): Promise<any> {\n    const update = await this.configuration.fetch(data)\n\n    if (update) {\n      Y.applyUpdate(data.document, update)\n    }\n\n    return data.document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onStoreDocument(data: onChangePayload) {\n    return this.configuration.store({\n      ...data,\n      state: Buffer.from(\n        Y.encodeStateAsUpdate(data.document),\n      ),\n    })\n  }\n}\n"],"names":[],"mappings":";;MAqBa,QAAQ,CAAA;AASnB;;AAEG;AACH,IAAA,WAAA,CAAY,aAA6C,EAAA;AAXzD;;AAEG;AACH,QAAA,IAAA,CAAA,aAAa,GAA0B;AACrC,YAAA,KAAK,EAAE,YAAY,IAAI;AACvB,YAAA,KAAK,EAAE,YAAY,IAAI;SACxB,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;AACrB,YAAA,GAAG,aAAa;SACjB,CAAA;KACF;AAED;;AAEG;IACH,MAAM,cAAc,CAAC,IAA2B,EAAA;QAC9C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAEnD,QAAA,IAAI,MAAM,EAAE;YACV,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;AACrC,SAAA;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;AAED;;AAEG;IACH,MAAM,eAAe,CAAC,IAAqB,EAAA;AACzC,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;AAC9B,YAAA,GAAG,IAAI;AACP,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAChB,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC;AACF,SAAA,CAAC,CAAA;KACH;AACF;;;;"}

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

@@ -1,12 +1,10 @@
-import { Extension, onChangePayload, onLoadDocumentPayload, storePayload } from '@hocuspocus/server';
+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: ({ documentName }: {
-        documentName: string;
-    }) => Promise<Uint8Array | null>;
+    fetch: (data: fetchPayload) => Promise<Uint8Array | null>;
     /**
      * Pass a function to store updates in your database.
      */
@@ -24,7 +22,7 @@ export declare class Database implements Extension {
     /**
      * Get stored data from the database.
      */
-    onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
     /**
      * Store new updates in the database.
      */

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

@@ -50,11 +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;
     }>;
+    private getIpAddress;
     private static readableYDoc;
 }

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

@@ -1,6 +1,6 @@
 import RedisClient from 'ioredis';
 import Redlock from 'redlock';
-import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, Debugger, onConfigurePayload } from '@hocuspocus/server';
+import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, Debugger, onConfigurePayload, onListenPayload } from '@hocuspocus/server';
 export interface Configuration {
     /**
      * Redis port
@@ -46,7 +46,7 @@ export declare class Redis implements Extension {
     logger: Debugger;
     constructor(configuration: Partial<Configuration>);
     onConfigure({ instance }: onConfigurePayload): Promise<void>;
-    onListen(): Promise<void>;
+    onListen({ configuration }: onListenPayload): Promise<void>;
     private getKey;
     private pubKey;
     private subKey;

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
-import { Configuration, Hook } from './types';
+import { Configuration, HookName, HookPayload } from './types';
 import Document from './Document';
 import { Debugger } from './Debugger';
 import { onListenPayload } from '.';
@@ -88,7 +88,7 @@ export declare class Hocuspocus {
      * Run the given hook on all configured extensions.
      * Runs the given callback after each hook.
      */
-    hooks(name: Hook, payload: any, callback?: Function | null): Promise<any>;
+    hooks(name: HookName, payload: HookPayload, callback?: Function | null): Promise<any>;
     /**
      * Get parameters by the given request
      */

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

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
 import { URLSearchParams } from 'url';
-import { Socket } from 'net';
 import { Awareness } from 'y-protocols/awareness';
 import Document from './Document';
 import { Hocuspocus } from './Hocuspocus';
@@ -44,11 +43,12 @@ export interface Extension {
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type Hook = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
+export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
 /**
  * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
  */
 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
 export interface Configuration extends Extension {
     /**
      * A name for the instance, used for logging.
@@ -179,6 +179,16 @@ export declare type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];
+export interface fetchPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
 export interface storePayload extends onStoreDocumentPayload {
     state: Buffer;
 }
@@ -198,19 +208,21 @@ export interface onRequestPayload {
     instance: Hocuspocus;
 }
 export interface onUpgradePayload {
-    head: any;
     request: IncomingMessage;
-    socket: Socket;
+    socket: any;
+    head: any;
     instance: Hocuspocus;
 }
 export interface onListenPayload {
+    instance: Hocuspocus;
+    configuration: Configuration;
     port: number;
 }
 export interface onDestroyPayload {
     instance: Hocuspocus;
 }
 export interface onConfigurePayload {
+    instance: Hocuspocus;
     configuration: Configuration;
     version: string;
-    instance: Hocuspocus;
 }

package/dist/tests/extension-database/fetch.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils/index.d.ts

@@ -2,6 +2,7 @@ export * from './createDirectory';
 export * from './flushRedis';
 export * from './newHocuspocus';
 export * from './newHocuspocusProvider';
+export * from './randomInteger';
 export * from './redisConnectionSettings';
 export * from './removeDirectory';
 export * from './sleep';

package/dist/tests/utils/randomInteger.d.ts

@@ -0,0 +1 @@
+export declare const randomInteger: (min: number, max: number) => number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/extension-database",
   "description": "a generic Hocuspocus persistence driver for the database",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.16",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus",
@@ -9,7 +9,7 @@
   ],
   "license": "MIT",
   "type": "module",
-  "main": "dist/hocuspocus-database.esm.js",
+  "main": "dist/hocuspocus-database.cjs",
   "module": "dist/hocuspocus-database.esm.js",
   "types": "dist/packages/extension-database/src/index.d.ts",
   "exports": {
@@ -26,11 +26,11 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^1.0.0-alpha.99",
+    "@hocuspocus/server": "^1.0.0-alpha.102",
     "yjs": "^13.5.29"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e26a5eeaa9278b9587d4b475cec53bf14bc569b9"
+  "gitHead": "450e12c89b027bc62683f151330a98074cd8e8fb"
 }

package/src/Database.ts

@@ -1,5 +1,9 @@
 import {
-  Extension, onChangePayload, onLoadDocumentPayload, storePayload,
+  Extension,
+  onChangePayload,
+  onLoadDocumentPayload,
+  storePayload,
+  fetchPayload,
 } from '@hocuspocus/server'
 import * as Y from 'yjs'
 
@@ -8,7 +12,7 @@ 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: ({ documentName }: { documentName: string}) => Promise<Uint8Array | null>,
+  fetch: (data: fetchPayload) => Promise<Uint8Array | null>,
   /**
    * Pass a function to store updates in your database.
    */
@@ -37,14 +41,14 @@ export class Database implements Extension {
   /**
    * Get stored data from the database.
    */
-  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {
-    const update = await this.configuration.fetch({ documentName })
+  async onLoadDocument(data: onLoadDocumentPayload): Promise<any> {
+    const update = await this.configuration.fetch(data)
 
     if (update) {
-      Y.applyUpdate(document, update)
+      Y.applyUpdate(data.document, update)
     }
 
-    return document
+    return data.document
   }
 
   /**