@hocuspocus/extension-database 1.0.0-alpha.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021, überdosis GbR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# @hocuspocus/extension-database
+[![Version](https://img.shields.io/npm/v/@hocuspocus/extension-database.svg?label=version)](https://www.npmjs.com/package/@hocuspocus/extension-database)
+[![Downloads](https://img.shields.io/npm/dm/@hocuspocus/extension-database.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
+[![License](https://img.shields.io/npm/l/@hocuspocus/extension-database.svg)](https://www.npmjs.com/package/@hocuspocus/extension-database)
+[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
+
+## Introduction
+hocuspocus is an opinionated collaborative editing backend for [tiptap](https://github.com/ueberdosis/tiptap) – based on [Y.js](https://github.com/yjs/yjs), a CRDT framework with a powerful abstraction of shared data.
+
+## Offical Documentation
+Documentation can be found in the [GitHub repository](https://github.com/ueberdosis/hocuspocus).
+
+## License
+hocuspocus is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/hocuspocus/blob/main/LICENSE.md).

package/dist/hocuspocus-database.cjs

@@ -0,0 +1,66 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Y = require('yjs');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var Y__namespace = /*#__PURE__*/_interopNamespace(Y);
+
+class Database {
+    /**
+     * Constructor
+     */
+    constructor(configuration) {
+        /**
+         * Default configuration
+         */
+        this.configuration = {
+            fetchUpdates: async () => [],
+            storeUpdate: async () => null,
+        };
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
+    }
+    /**
+     * Get stored data from the database.
+     */
+    async onLoadDocument({ document, documentName }) {
+        const updates = await this.configuration.fetchUpdates({ documentName });
+        if (updates && updates.length) {
+            updates.forEach((update) => {
+                Y__namespace.applyUpdate(document, update);
+            });
+        }
+        return document;
+    }
+    /**
+     * Store new updates in the database.
+     */
+    async onChange({ document, documentName }) {
+        const update = Buffer.from(Y__namespace.encodeStateAsUpdate(document));
+        return this.configuration.storeUpdate({ update, documentName });
+    }
+}
+
+exports.Database = Database;
+//# sourceMappingURL=hocuspocus-database.cjs.map

package/dist/hocuspocus-database.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"hocuspocus-database.cjs","sources":["../src/Database.ts"],"sourcesContent":["import { Extension, onChangePayload, onLoadDocumentPayload } 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  fetchUpdates: ({ documentName }: { documentName: string}) => Promise<Uint8Array[]>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  storeUpdate: ({ update, documentName }: { update: Buffer, documentName: string}) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetchUpdates: async () => [],\n    storeUpdate: 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 updates = await this.configuration.fetchUpdates({ documentName })\n\n    if (updates && updates.length) {\n      updates.forEach((update: any) => {\n        Y.applyUpdate(document, update)\n      })\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onChange({ document, documentName }: onChangePayload) {\n    const update = Buffer.from(\n      Y.encodeStateAsUpdate(document),\n    )\n\n    return this.configuration.storeUpdate({ update, documentName })\n  }\n}\n"],"names":["Y"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;MAea,QAAQ;;;;IAYnB,YAAY,aAA6C;;;;QARzD,kBAAa,GAA0B;YACrC,YAAY,EAAE,YAAY,EAAE;YAC5B,WAAW,EAAE,YAAY,IAAI;SAC9B,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB;QACpE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;QAEvE,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,OAAO,CAAC,CAAC,MAAW;gBAC1BA,YAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;aAChC,CAAC,CAAA;SACH;QAED,OAAO,QAAQ,CAAA;KAChB;;;;IAKD,MAAM,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAmB;QACxD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CACxBA,YAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAChC,CAAA;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;KAChE;;;;;"}

package/dist/hocuspocus-database.esm.js

@@ -0,0 +1,42 @@
+import * as Y from 'yjs';
+
+class Database {
+    /**
+     * Constructor
+     */
+    constructor(configuration) {
+        /**
+         * Default configuration
+         */
+        this.configuration = {
+            fetchUpdates: async () => [],
+            storeUpdate: async () => null,
+        };
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
+    }
+    /**
+     * Get stored data from the database.
+     */
+    async onLoadDocument({ document, documentName }) {
+        const updates = await this.configuration.fetchUpdates({ documentName });
+        if (updates && updates.length) {
+            updates.forEach((update) => {
+                Y.applyUpdate(document, update);
+            });
+        }
+        return document;
+    }
+    /**
+     * Store new updates in the database.
+     */
+    async onChange({ document, documentName }) {
+        const update = Buffer.from(Y.encodeStateAsUpdate(document));
+        return this.configuration.storeUpdate({ update, documentName });
+    }
+}
+
+export { Database };
+//# sourceMappingURL=hocuspocus-database.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hocuspocus-database.esm.js","sources":["../src/Database.ts"],"sourcesContent":["import { Extension, onChangePayload, onLoadDocumentPayload } 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  fetchUpdates: ({ documentName }: { documentName: string}) => Promise<Uint8Array[]>,\n  /**\n   * Pass a function to store updates in your database.\n   */\n  storeUpdate: ({ update, documentName }: { update: Buffer, documentName: string}) => void,\n}\n\nexport class Database implements Extension {\n  /**\n   * Default configuration\n   */\n  configuration: DatabaseConfiguration = {\n    fetchUpdates: async () => [],\n    storeUpdate: 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 updates = await this.configuration.fetchUpdates({ documentName })\n\n    if (updates && updates.length) {\n      updates.forEach((update: any) => {\n        Y.applyUpdate(document, update)\n      })\n    }\n\n    return document\n  }\n\n  /**\n   * Store new updates in the database.\n   */\n  async onChange({ document, documentName }: onChangePayload) {\n    const update = Buffer.from(\n      Y.encodeStateAsUpdate(document),\n    )\n\n    return this.configuration.storeUpdate({ update, documentName })\n  }\n}\n"],"names":[],"mappings":";;MAea,QAAQ;;;;IAYnB,YAAY,aAA6C;;;;QARzD,kBAAa,GAA0B;YACrC,YAAY,EAAE,YAAY,EAAE;YAC5B,WAAW,EAAE,YAAY,IAAI;SAC9B,CAAA;QAMC,IAAI,CAAC,aAAa,GAAG;YACnB,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,aAAa;SACjB,CAAA;KACF;;;;IAKD,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAyB;QACpE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC,CAAA;QAEvE,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;YAC7B,OAAO,CAAC,OAAO,CAAC,CAAC,MAAW;gBAC1B,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;aAChC,CAAC,CAAA;SACH;QAED,OAAO,QAAQ,CAAA;KAChB;;;;IAKD,MAAM,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAmB;QACxD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CACxB,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAChC,CAAA;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;KAChE;;;;;"}

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

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

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

@@ -0,0 +1,62 @@
+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 `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>;
+    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/extension-monitor/src/Collector.d.ts

@@ -0,0 +1,62 @@
+/// <reference types="node" />
+import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPayload, onChangePayload } from '@hocuspocus/server';
+export declare class Collector {
+    serverConfiguration: Partial<Configuration>;
+    version: string;
+    yjsVersion: string;
+    connections: {};
+    messages: {};
+    messageCounter: number;
+    memory(): Promise<{
+        free: number;
+        total: number;
+        usage: number;
+    }>;
+    cpu(): Promise<{
+        count: number;
+        model: string;
+        usage: number;
+    }>;
+    connect(data: onConnectPayload): {
+        action: string;
+        documentName: string;
+        socketId: string;
+    };
+    disconnect(data: onDisconnectPayload): {
+        action: string;
+        documentName: string;
+        socketId: string;
+    };
+    connectionCount(): {
+        count: string | number;
+    };
+    createDocument(data: onLoadDocumentPayload): {
+        action: string;
+        document: any;
+        documentName: string;
+        socketId: string;
+    };
+    changeDocument(data: onChangePayload): {
+        action: string;
+        document: any;
+        documentName: string;
+        socketId: string;
+    };
+    messageCount(): {
+        count: number;
+    };
+    documentCount(): {
+        count: number;
+    };
+    documents(): {};
+    info(): Promise<{
+        configuration: Partial<Configuration>;
+        ipAddress: string;
+        nodeVersion: string;
+        platform: NodeJS.Platform;
+        started: string;
+        version: string;
+        yjsVersion: string;
+    }>;
+    private static readableYDoc;
+}

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

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+import WebSocket, { WebSocketServer } from 'ws';
+import { Socket } from 'net';
+import { Storage } from './Storage';
+export interface Configuration {
+    password: string | undefined;
+    path: string;
+    port: number | undefined;
+    storage: Storage | undefined;
+    user: string | undefined;
+}
+export declare class Dashboard {
+    configuration: Configuration;
+    websocketServer: WebSocketServer;
+    connections: Map<WebSocket, any>;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<Configuration>);
+    createServer(): void;
+    handleRequest(request: IncomingMessage, response: ServerResponse): boolean;
+    handleUpgrade(request: IncomingMessage, socket: Socket, head: any): boolean;
+    handleConnection(connection: WebSocket, request: IncomingMessage): void;
+    close(connection: WebSocket): void;
+    send(message: string): void;
+    private sendInitialDataToClient;
+    private basicAuth;
+}

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

@@ -0,0 +1,35 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+export declare class Storage extends EventEmitter {
+    timed: Map<string, any>;
+    constant: Map<string, any>;
+    /**
+     * Get all constant values.
+     */
+    all(): Promise<any>;
+    /**
+     * Get a constant value by the given key.
+     */
+    get(key: string, defaultValue?: any): Promise<any>;
+    /**
+     * Set a constant value by the given key.
+     */
+    set(key: string, value: any): Promise<any>;
+    /**
+     * Delete a constant value by the given key.
+     * @param key
+     */
+    delete(key: string): Promise<any>;
+    /**
+     * Get all timed values.
+     */
+    allTimed(): Promise<any>;
+    /**
+     * Add a timed value by the given key.
+     */
+    add(key: string, value: any): Promise<any>;
+    /**
+     * Remove a timed value by the given timestamp and key.
+     */
+    remove(key: string, timestamp: string): Promise<any>;
+}

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

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { IncomingMessage, ServerResponse } from 'http';
+import WebSocket from 'ws';
+import { Storage } from './Storage';
+import { Dashboard } from './Dashboard';
+import { Collector } from './Collector';
+export interface Configuration {
+    dashboardPath: string;
+    enableDashboard: boolean;
+    metricsInterval: number;
+    osMetricsInterval: number;
+    password: string | undefined;
+    port: number | undefined;
+    user: string | undefined;
+}
+export declare class Monitor implements Extension {
+    configuration: Configuration;
+    storage: Storage;
+    collector: Collector;
+    dashboard?: Dashboard;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<Configuration>);
+    private collectOsMetrics;
+    private collectConnectionMetrics;
+    private cleanMetrics;
+    handleRequest(request: IncomingMessage, response: ServerResponse): boolean | undefined;
+    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>;
+    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
+    onChange(data: onChangePayload): Promise<void>;
+    onConfigure(data: onConfigurePayload): Promise<void>;
+}

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

@@ -0,0 +1,16 @@
+import { RedisPersistence } from 'y-redis';
+import { Extension, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+export interface Configuration {
+}
+export declare class Redis implements Extension {
+    configuration: Configuration;
+    cluster: boolean;
+    persistence: RedisPersistence | undefined;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<Configuration>);
+    onLoadDocument(data: onLoadDocumentPayload): Promise<import("yjs").Doc | undefined>;
+    onConnect(data: onConnectPayload): Promise<void>;
+    onDisconnect(data: onDisconnectPayload): Promise<void>;
+}

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

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

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

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

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

@@ -0,0 +1,22 @@
+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/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-throttle/src/index.d.ts

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

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

@@ -0,0 +1,59 @@
+/// <reference types="node" />
+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",
+    onCreate = "create",
+    onDisconnect = "disconnect"
+}
+export interface Configuration {
+    debounce: number | false | null;
+    debounceMaxWait: number;
+    secret: string;
+    transformer: Transformer | {
+        toYdoc: (document: any) => Doc;
+        fromYdoc: (document: Doc) => any;
+    };
+    url: string;
+    events: Array<Events>;
+}
+export declare class Webhook implements Extension {
+    configuration: Configuration;
+    debounced: Map<string, {
+        timeout: Timeout;
+        start: number;
+    }>;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<Configuration>);
+    /**
+     * Create a signature for the response body
+     */
+    createSignature(body: string): string;
+    /**
+     * debounce the given function, using the given identifier
+     */
+    debounce(id: string, func: Function): void;
+    /**
+     * Send a request to the given url containing the given data
+     */
+    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any, any>>;
+    /**
+     * onChange hook
+     */
+    onChange(data: onChangePayload): Promise<void>;
+    /**
+     * onLoadDocument hook
+     */
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
+    /**
+     * onConnect hook
+     */
+    onConnect(data: onConnectPayload): Promise<any>;
+    onDisconnect(data: onDisconnectPayload): 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;
+    protected removeAllListeners(): void;
+}

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

@@ -0,0 +1,10 @@
+import { HocuspocusProvider, HocuspocusProviderOptions } from './HocuspocusProvider';
+export interface HocuspocusCloudProviderOptions extends HocuspocusProviderOptions {
+    /**
+     * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+     */
+    key: string;
+}
+export declare class HocuspocusCloudProvider extends HocuspocusProvider {
+    constructor(options: HocuspocusCloudProviderOptions);
+}