@hocuspocus/common 2.1.0-alpha.0 → 2.2.0

package/dist/packages/common/src/CloseEvents.d.ts

@@ -1,29 +1,29 @@
-export interface CloseEvent {
-    code: number;
-    reason: string;
-}
-/**
- * The server is terminating the connection because a data frame was received
- * that is too large.
- * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
- */
-export declare const MessageTooBig: CloseEvent;
-/**
- * The server successfully processed the request, asks that the requester reset
- * its document view, and is not returning any content.
- */
-export declare const ResetConnection: CloseEvent;
-/**
- * Similar to Forbidden, but specifically for use when authentication is required and has
- * failed or has not yet been provided.
- */
-export declare const Unauthorized: CloseEvent;
-/**
- * The request contained valid data and was understood by the server, but the server
- * is refusing action.
- */
-export declare const Forbidden: CloseEvent;
-/**
- * The server timed out waiting for the request.
- */
-export declare const ConnectionTimeout: CloseEvent;
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}
+/**
+ * The server is terminating the connection because a data frame was received
+ * that is too large.
+ * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
+ */
+export declare const MessageTooBig: CloseEvent;
+/**
+ * The server successfully processed the request, asks that the requester reset
+ * its document view, and is not returning any content.
+ */
+export declare const ResetConnection: CloseEvent;
+/**
+ * Similar to Forbidden, but specifically for use when authentication is required and has
+ * failed or has not yet been provided.
+ */
+export declare const Unauthorized: CloseEvent;
+/**
+ * The request contained valid data and was understood by the server, but the server
+ * is refusing action.
+ */
+export declare const Forbidden: CloseEvent;
+/**
+ * The server timed out waiting for the request.
+ */
+export declare const ConnectionTimeout: CloseEvent;

package/dist/packages/common/src/auth.d.ts

@@ -1,6 +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;
+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, scope: 'readonly' | 'read-write') => void;
+export declare const readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;

package/dist/packages/common/src/awarenessStatesToArray.d.ts

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

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

@@ -1,4 +1,4 @@
-export * from './auth';
-export * from './CloseEvents';
-export * from './awarenessStatesToArray';
-export * from './types';
+export * from './auth.js';
+export * from './CloseEvents.js';
+export * from './awarenessStatesToArray.js';
+export * from './types.js';

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

@@ -1,10 +1,10 @@
-/**
- * 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
-}
+/**
+ * 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
+}

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

@@ -1,30 +1,30 @@
-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: (data: fetchPayload) => Promise<Uint8Array | null>;
-    /**
-     * Pass a function to store updates in your database.
-     */
-    store: (data: storePayload) => void;
-}
-export declare class Database implements Extension {
-    /**
-     * Default configuration
-     */
-    configuration: DatabaseConfiguration;
-    /**
-     * Constructor
-     */
-    constructor(configuration: Partial<DatabaseConfiguration>);
-    /**
-     * Get stored data from the database.
-     */
-    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
-    /**
-     * Store new updates in the database.
-     */
-    onStoreDocument(data: onChangePayload): Promise<void>;
-}
+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: (data: fetchPayload) => Promise<Uint8Array | null>;
+    /**
+     * Pass a function to store updates in your database.
+     */
+    store: (data: storePayload) => void;
+}
+export declare class Database implements Extension {
+    /**
+     * Default configuration
+     */
+    configuration: DatabaseConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration: Partial<DatabaseConfiguration>);
+    /**
+     * Get stored data from the database.
+     */
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
+    /**
+     * Store new updates in the database.
+     */
+    onStoreDocument(data: onChangePayload): Promise<void>;
+}

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

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

package/dist/packages/extension-logger/src/Logger.d.ts

@@ -1,67 +1,67 @@
-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 `onStoreDocument` hook.
-     */
-    onStoreDocument: 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>;
-    onStoreDocument(data: onDisconnectPayload): 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;
-}
+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 `onStoreDocument` hook.
+     */
+    onStoreDocument: 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>;
+    onStoreDocument(data: onDisconnectPayload): 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

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

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';