@hocuspocus/extension-database 1.0.0-alpha.1

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

@@ -0,0 +1,158 @@
+/// <reference types="node" />
+import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
+import { URLSearchParams } from 'url';
+import { Socket } from 'net';
+import Document from './Document';
+import { Hocuspocus } from './Hocuspocus';
+export declare enum MessageType {
+    Unknown = -1,
+    Sync = 0,
+    Awareness = 1,
+    Auth = 2
+}
+/**
+ * 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
+}
+export interface AwarenessUpdate {
+    added: Array<any>;
+    updated: Array<any>;
+    removed: Array<any>;
+}
+export interface ConnectionConfig {
+    readOnly: boolean;
+    isAuthenticated: boolean;
+}
+export interface Extension {
+    onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
+    onChange?(data: onChangePayload): Promise<any>;
+    onConnect?(data: onConnectPayload): Promise<any>;
+    onConfigure?(data: onConfigurePayload): Promise<any>;
+    /**
+     * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+     */
+    onCreateDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onDestroy?(data: onDestroyPayload): Promise<any>;
+    onDisconnect?(data: onDisconnectPayload): Promise<any>;
+    onListen?(data: onListenPayload): Promise<any>;
+    onRequest?(data: onRequestPayload): Promise<any>;
+    onUpgrade?(data: onUpgradePayload): Promise<any>;
+}
+export declare type Hook = 'onAuthenticate' | 'onChange' | 'onConnect' | 'onConfigure' | 
+/**
+ * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+ */
+'onCreateDocument' | 'onLoadDocument' | 'onDestroy' | 'onDisconnect' | 'onListen' | 'onRequest' | 'onUpgrade';
+export interface Configuration extends Extension {
+    /**
+     * A name for the instance, used for logging.
+     */
+    name: string | null;
+    /**
+     * A list of hocuspocus extenions.
+     */
+    extensions: Array<Extension>;
+    /**
+     * The port which the server listens on.
+     */
+    port: number | null;
+    /**
+     * 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
+     */
+    getDocumentName?(data: {
+        documentName: string;
+        request: IncomingMessage;
+        requestParameters: URLSearchParams;
+    }): string | Promise<string>;
+}
+export interface onAuthenticatePayload {
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    token: string;
+    connection: ConnectionConfig;
+}
+export interface onConnectPayload {
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfig;
+}
+export interface onLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfig;
+}
+export interface onChangePayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    update: Uint8Array;
+    socketId: string;
+}
+export interface onDisconnectPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+}
+export interface onRequestPayload {
+    request: IncomingMessage;
+    response: ServerResponse;
+    instance: Hocuspocus;
+}
+export interface onUpgradePayload {
+    head: any;
+    request: IncomingMessage;
+    socket: Socket;
+    instance: Hocuspocus;
+}
+export interface onListenPayload {
+    port: number;
+}
+export interface onDestroyPayload {
+    instance: Hocuspocus;
+}
+export interface onConfigurePayload {
+    configuration: Configuration;
+    version: string;
+    yjsVersion: string;
+    instance: Hocuspocus;
+}
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}

package/dist/packages/transformer/src/Prosemirror.d.ts

@@ -0,0 +1,11 @@
+import { Doc } from 'yjs';
+import { Schema } from 'prosemirror-model';
+import { Transformer } from './types';
+declare class Prosemirror implements Transformer {
+    defaultSchema: Schema;
+    schema(schema: Schema): Prosemirror;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, schema?: Schema): Doc;
+}
+export declare const ProsemirrorTransformer: Prosemirror;
+export {};

package/dist/packages/transformer/src/Tiptap.d.ts

@@ -0,0 +1,10 @@
+import { Doc } from 'yjs';
+import { Extensions } from '@tiptap/core/dist/packages/core/src/types';
+import { Transformer } from './types';
+export declare class Tiptap implements Transformer {
+    defaultExtensions: Extensions;
+    extensions(extensions: Extensions): Tiptap;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, extensions?: Extensions): Doc;
+}
+export declare const TiptapTransformer: Tiptap;

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

@@ -0,0 +1,3 @@
+export * from './Prosemirror';
+export * from './Tiptap';
+export * from './types';

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

@@ -0,0 +1,5 @@
+import { Doc } from 'yjs';
+export interface Transformer {
+    fromYdoc: (document: Doc, fieldName?: string | Array<string>) => any;
+    toYdoc: (document: any, fieldName: string) => Doc;
+}

package/dist/playground/backend/src/default.d.ts

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

package/dist/playground/backend/src/express.d.ts

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

package/dist/playground/backend/src/koa.d.ts

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

package/dist/playground/backend/src/load-document.d.ts

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

package/dist/playground/backend/src/monitor.d.ts

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

package/dist/playground/backend/src/redis.d.ts

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

package/dist/playground/backend/src/slow.d.ts

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

package/dist/playground/backend/src/webhook.d.ts

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

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@hocuspocus/extension-database",
+  "description": "a generic Hocuspocus persistence driver for the database",
+  "version": "1.0.0-alpha.1",
+  "homepage": "https://hocuspocus.dev",
+  "keywords": [
+    "hocuspocus",
+    "yjs"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/hocuspocus-database.esm.js",
+  "module": "dist/hocuspocus-database.esm.js",
+  "types": "dist/packages/extension-database/src/index.d.ts",
+  "exports": {
+    "source": {
+      "import": "./src"
+    },
+    "default": {
+      "import": "./dist/hocuspocus-database.esm.js",
+      "require": "./dist/hocuspocus-database.cjs"
+    }
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "dependencies": {
+    "@hocuspocus/server": "^1.0.0-alpha.87",
+    "yjs": "^13.5.22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "8ffe8d8f4d10ba33f4f203806bd1d4415bef5dc3"
+}

package/src/Database.ts

@@ -0,0 +1,60 @@
+import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server'
+import * as Y from 'yjs'
+
+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 class Database implements Extension {
+  /**
+   * Default configuration
+   */
+  configuration: DatabaseConfiguration = {
+    fetchUpdates: async () => [],
+    storeUpdate: async () => null,
+  }
+
+  /**
+   * Constructor
+   */
+  constructor(configuration: Partial<DatabaseConfiguration>) {
+    this.configuration = {
+      ...this.configuration,
+      ...configuration,
+    }
+  }
+
+  /**
+   * Get stored data from the database.
+   */
+  async onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any> {
+    const updates = await this.configuration.fetchUpdates({ documentName })
+
+    if (updates && updates.length) {
+      updates.forEach((update: any) => {
+        Y.applyUpdate(document, update)
+      })
+    }
+
+    return 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 })
+  }
+}

package/src/index.ts

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