@hocuspocus/extension-sqlite 2.1.0-alpha.0 → 2.1.0

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

@@ -1,95 +1,116 @@
-import RedisClient, { ClusterNode, ClusterOptions, RedisOptions, Cluster as RedisClusterClient } from 'ioredis';
-import { Extension, afterLoadDocumentPayload, onDisconnectPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, beforeBroadcastStatelessPayload, Hocuspocus } from '@hocuspocus/server';
-export type RedisInstance = RedisClient | RedisClusterClient;
-export interface Configuration {
-    /**
-     * Redis port
-     */
-    port: number;
-    /**
-     * Redis host
-     */
-    host: string;
-    /**
-     * Redis Cluster
-     */
-    nodes?: ClusterNode[];
-    /**
-     * Duplicate from an existed Redis instance
-     */
-    redis?: RedisInstance;
-    /**
-     * Redis instance creator
-     */
-    createClient?: () => RedisInstance;
-    /**
-     * Options passed directly to Redis constructor
-     *
-     * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
-     */
-    options?: ClusterOptions | 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;
-    /**
-     * A delay before onDisconnect is executed. This allows last minute updates'
-     * sync messages to be received by the subscription before it's closed.
-     */
-    disconnectDelay: 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: RedisInstance;
-    sub: RedisInstance;
-    instance: Hocuspocus;
-    logger: Debugger;
-    constructor(configuration: Partial<Configuration>);
-    onConfigure({ instance }: onConfigurePayload): Promise<void>;
-    private getKey;
-    private pubKey;
-    private subKey;
-    /**
-     * 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;
-    /**
-     * 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 }: onDisconnectPayload) => Promise<void>;
-    beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
-}
+import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
+import Redlock from 'redlock';
+import { Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, beforeBroadcastStatelessPayload, Hocuspocus } from '@hocuspocus/server';
+export type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
+export interface Configuration {
+    /**
+     * Redis port
+     */
+    port: number;
+    /**
+     * Redis host
+     */
+    host: string;
+    /**
+     * Redis Cluster
+     */
+    nodes?: ClusterNode[];
+    /**
+     * Duplicate from an existed Redis instance
+     */
+    redis?: RedisInstance;
+    /**
+     * Redis instance creator
+     */
+    createClient?: () => RedisInstance;
+    /**
+     * Options passed directly to Redis constructor
+     *
+     * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
+     */
+    options?: ClusterOptions | 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;
+    /**
+     * A delay before onDisconnect is executed. This allows last minute updates'
+     * sync messages to be received by the subscription before it's closed.
+     */
+    disconnectDelay: 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: RedisInstance;
+    sub: RedisInstance;
+    instance: Hocuspocus;
+    redlock: Redlock;
+    locks: Map<string, Redlock.Lock>;
+    logger: Debugger;
+    constructor(configuration: Partial<Configuration>);
+    onConfigure({ instance }: onConfigurePayload): 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 }: onDisconnectPayload) => Promise<void>;
+    beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
+    /**
+     * Kill the Redlock connection immediately.
+     */
+    onDestroy(): Promise<void>;
+}

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

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

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

@@ -1,26 +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>;
-}
+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

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

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

@@ -1,31 +1,31 @@
-/// <reference types="node" />
-import { Extension, onConnectPayload } from '@hocuspocus/server';
-export interface ThrottleConfiguration {
-    throttle: number | null | false;
-    consideredSeconds: number;
-    banTime: number;
-    cleanupInterval: number;
-}
-export declare class Throttle implements Extension {
-    configuration: ThrottleConfiguration;
-    connectionsByIp: Map<string, Array<number>>;
-    bannedIps: Map<string, number>;
-    cleanupInterval?: NodeJS.Timer;
-    /**
-     * Constructor
-     */
-    constructor(configuration?: Partial<ThrottleConfiguration>);
-    onDestroy(): Promise<void>;
-    clearMaps(): void;
-    isBanned(ip: string): boolean;
-    /**
-     * Throttle requests
-     * @private
-     */
-    private throttle;
-    /**
-     * onConnect hook
-     * @param data
-     */
-    onConnect(data: onConnectPayload): Promise<any>;
-}
+/// <reference types="node" />
+import { Extension, onConnectPayload } from '@hocuspocus/server';
+export interface ThrottleConfiguration {
+    throttle: number | null | false;
+    consideredSeconds: number;
+    banTime: number;
+    cleanupInterval: number;
+}
+export declare class Throttle implements Extension {
+    configuration: ThrottleConfiguration;
+    connectionsByIp: Map<string, Array<number>>;
+    bannedIps: Map<string, number>;
+    cleanupInterval?: NodeJS.Timer;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<ThrottleConfiguration>);
+    onDestroy(): Promise<void>;
+    clearMaps(): void;
+    isBanned(ip: string): boolean;
+    /**
+     * Throttle requests
+     * @private
+     */
+    private throttle;
+    /**
+     * onConnect hook
+     * @param data
+     */
+    onConnect(data: onConnectPayload): Promise<any>;
+}

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

@@ -1,57 +1,57 @@
-/// <reference types="node" />
-import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
-import { Doc } from 'yjs';
-import { Transformer } from '@hocuspocus/transformer';
-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: NodeJS.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<import("axios").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>;
-}
+/// <reference types="node" />
+import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import { Doc } from 'yjs';
+import { Transformer } from '@hocuspocus/transformer';
+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: NodeJS.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<import("axios").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

@@ -1,9 +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;
-}
+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;
+}