@hocuspocus/extension-database 1.0.0-alpha.2 → 1.0.0-alpha.20

package/dist/tests/server/onDisconnect.d.ts

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

package/dist/tests/server/onListen.d.ts

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

package/dist/tests/server/onLoadDocument.d.ts

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

package/dist/tests/server/onRequest.d.ts

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

package/dist/tests/server/onStoreDocument.d.ts

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

package/dist/tests/server/onUpgrade.d.ts

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

package/dist/tests/server/requiresAuthentication.d.ts

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

package/dist/tests/server/websocketError.d.ts

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

package/dist/tests/transformer/TiptapTransformer.d.ts

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

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

@@ -0,0 +1 @@
+export declare const createDirectory: (dir: string) => void;

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

@@ -0,0 +1 @@
+export declare const flushRedis: () => Promise<string>;

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

@@ -0,0 +1,8 @@
+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/newHocuspocus.d.ts

@@ -0,0 +1,2 @@
+import { Hocuspocus, Configuration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<Configuration> | undefined) => Hocuspocus;

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

@@ -0,0 +1,3 @@
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from '@hocuspocus/provider';
+import { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderConfiguration, 'url'>>) => HocuspocusProvider;

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

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

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

@@ -0,0 +1,4 @@
+export declare const redisConnectionSettings: {
+    host: string;
+    port: number;
+};

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

@@ -0,0 +1 @@
+export declare const removeDirectory: (dir: string) => void;

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

@@ -0,0 +1,2 @@
+import { ExecutionContext } from 'ava';
+export declare const retryableAssertion: (t: ExecutionContext, recoverableTry: (tt: ExecutionContext) => void) => Promise<void>;

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

@@ -0,0 +1 @@
+export declare const sleep: (time: number) => Promise<unknown>;

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.2",
+  "version": "1.0.0-alpha.20",
   "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.88",
-    "yjs": "^13.5.22"
+    "@hocuspocus/server": "^1.0.0-alpha.106",
+    "yjs": "^13.5.29"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "09919438a0a220ffb7479afc562872c8726cc4b4"
+  "gitHead": "6074a6cb832b40bc579f28db2823ba5723887312"
 }

package/src/Database.ts

@@ -1,4 +1,10 @@
-import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server'
+import {
+  Extension,
+  onChangePayload,
+  onLoadDocumentPayload,
+  storePayload,
+  fetchPayload,
+} from '@hocuspocus/server'
 import * as Y from 'yjs'
 
 export interface DatabaseConfiguration {
@@ -6,11 +12,11 @@ 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[]>,
+  fetch: (data: fetchPayload) => Promise<Uint8Array | null>,
   /**
    * Pass a function to store updates in your database.
    */
-  storeUpdate: ({ update, documentName }: { update: Buffer, documentName: string}) => void,
+  store: (data: storePayload) => void,
 }
 
 export class Database implements Extension {
@@ -18,8 +24,8 @@ export class Database implements Extension {
    * Default configuration
    */
   configuration: DatabaseConfiguration = {
-    fetchUpdates: async () => [],
-    storeUpdate: async () => null,
+    fetch: async () => null,
+    store: async () => null,
   }
 
   /**
@@ -35,26 +41,25 @@ export class Database implements Extension {
   /**
    * Get stored data from the database.
    */
-  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {
-    const updates = await this.configuration.fetchUpdates({ documentName })
+  async onLoadDocument(data: onLoadDocumentPayload): Promise<any> {
+    const update = await this.configuration.fetch(data)
 
-    if (updates && updates.length) {
-      updates.forEach((update: any) => {
-        Y.applyUpdate(document, update)
-      })
+    if (update) {
+      Y.applyUpdate(data.document, update)
     }
 
-    return document
+    return data.document
   }
 
   /**
    * Store new updates in the database.
    */
-  async onChange({ document, documentName }: onChangePayload) {
-    const update = Buffer.from(
-      Y.encodeStateAsUpdate(document),
-    )
-
-    return this.configuration.storeUpdate({ update, documentName })
+  async onStoreDocument(data: onChangePayload) {
+    return this.configuration.store({
+      ...data,
+      state: Buffer.from(
+        Y.encodeStateAsUpdate(data.document),
+      ),
+    })
   }
 }

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

@@ -1,4 +0,0 @@
-import { Redis } from './Redis';
-export declare class RedisCluster extends Redis {
-    cluster: boolean;
-}

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

@@ -1,22 +0,0 @@
-import { Extension, onLoadDocumentPayload } from '@hocuspocus/server';
-import { LeveldbPersistence } from 'y-leveldb';
-export interface Configuration {
-    options: object | undefined;
-    path: string;
-}
-export declare class RocksDB implements Extension {
-    configuration: Configuration;
-    provider: LeveldbPersistence;
-    /**
-     * Constructor
-     */
-    constructor(configuration?: Partial<Configuration>);
-    /**
-     * onLoadDocument hook
-     */
-    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
-    /**
-     * store updates in y-leveldb persistence
-     */
-    store(documentName: string, update: Uint8Array): Promise<any>;
-}

package/dist/packages/provider/src/utils/awarenessStatesToArray.d.ts

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

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

@@ -1 +0,0 @@
-export { default as awarenessStatesToArray } from './awarenessStatesToArray';

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[];