@hocuspocus/provider 1.0.0-alpha.33 → 1.0.0-alpha.36

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

@@ -3,7 +3,6 @@ import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPay
 export declare class Collector {
     serverConfiguration: Partial<Configuration>;
     version: string;
-    yjsVersion: string;
     connections: {};
     messages: {};
     messageCounter: number;
@@ -51,12 +50,12 @@ export declare class Collector {
     documents(): {};
     info(): Promise<{
         configuration: Partial<Configuration>;
-        ipAddress: string;
+        ipAddress: string | null;
         nodeVersion: string;
         platform: NodeJS.Platform;
         started: string;
         version: string;
-        yjsVersion: string;
     }>;
+    private getIpAddress;
     private static readableYDoc;
 }

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

@@ -1,16 +1,94 @@
-import { RedisPersistence } from 'y-redis';
-import { Extension, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import RedisClient from 'ioredis';
+import Redlock from 'redlock';
+import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, Debugger, onConfigurePayload, onListenPayload } from '@hocuspocus/server';
 export interface Configuration {
+    /**
+     * Redis port
+     */
+    port: number;
+    /**
+     * Redis host
+     */
+    host: string;
+    /**
+     * Options passed directly to Redis constructor
+     *
+     * https://github.com/luin/ioredis/blob/master/API.md#new-redisport-host-options
+     */
+    options?: RedisClient.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;
 }
 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;
-    cluster: boolean;
-    persistence: RedisPersistence | undefined;
+    pub: RedisClient.Redis;
+    sub: RedisClient.Redis;
+    documents: Map<string, Document>;
+    redlock: Redlock;
+    locks: Map<string, Redlock.Lock>;
+    logger: Debugger;
+    constructor(configuration: Partial<Configuration>);
+    onConfigure({ instance }: onConfigurePayload): Promise<void>;
+    onListen({ configuration }: onListenPayload): 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 }: 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;
+    /**
+     * Make sure to *not* listen for further changes, when there’s
+     * noone connected anymore.
+     */
+    onDisconnect: ({ documentName, clientsCount }: onDisconnectPayload) => Promise<void>;
     /**
-     * Constructor
+     * Kill the Redlock connection immediately.
      */
-    constructor(configuration?: Partial<Configuration>);
-    onLoadDocument(data: onLoadDocumentPayload): Promise<import("yjs").Doc | undefined>;
-    onConnect(data: onConnectPayload): Promise<void>;
-    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onDestroy(): Promise<void>;
 }

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

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

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

@@ -3,14 +3,8 @@ import { Awareness } from 'y-protocols/awareness';
 import * as mutex from 'lib0/mutex';
 import type { Event, CloseEvent, MessageEvent } from 'ws';
 import EventEmitter from './EventEmitter';
-import { OutgoingMessage } from './OutgoingMessage';
-import { ConstructableOutgoingMessage } from './types';
+import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
-export declare enum WebSocketStatus {
-    Connecting = "connecting",
-    Connected = "connected",
-    Disconnected = "disconnected"
-}
 export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
 export interface CompleteHocuspocusProviderConfiguration {
     /**
@@ -92,22 +86,18 @@ export interface CompleteHocuspocusProviderConfiguration {
      */
     timeout: number;
     onAuthenticated: () => void;
-    onAuthenticationFailed: ({ reason }: {
-        reason: string;
-    }) => void;
-    onOpen: (event: Event) => void;
+    onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
+    onOpen: (data: onOpenParameters) => void;
     onConnect: () => void;
-    onMessage: (event: MessageEvent) => void;
-    onOutgoingMessage: (message: OutgoingMessage) => void;
-    onStatus: (status: any) => void;
-    onSynced: ({ state }: {
-        state: boolean;
-    }) => void;
-    onDisconnect: (event: CloseEvent) => void;
-    onClose: (event: CloseEvent) => void;
+    onMessage: (data: onMessageParameters) => void;
+    onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
+    onStatus: (data: onStatusParameters) => void;
+    onSynced: (data: onSyncedParameters) => void;
+    onDisconnect: (data: onDisconnectParameters) => void;
+    onClose: (data: onCloseParameters) => void;
     onDestroy: () => void;
-    onAwarenessUpdate: ({ states }: onAwarenessUpdateParameters) => void;
-    onAwarenessChange: ({ states }: onAwarenessChangeParameters) => void;
+    onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
+    onAwarenessChange: (data: onAwarenessChangeParameters) => void;
     /**
      * Don’t output any warnings.
      */

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

@@ -1,18 +1,26 @@
 import { Awareness } from 'y-protocols/awareness';
 import * as Y from 'yjs';
 import { Encoder } from 'lib0/encoding';
+import type { Event, CloseEvent, MessageEvent } from 'ws';
 import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage';
 import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage';
 import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage';
 import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage';
 import { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage';
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage';
+import { IncomingMessage } from './IncomingMessage';
+import { OutgoingMessage } from './OutgoingMessage';
 export declare enum MessageType {
     Sync = 0,
     Awareness = 1,
     Auth = 2,
     QueryAwareness = 3
 }
+export declare enum WebSocketStatus {
+    Connecting = "connecting",
+    Connected = "connected",
+    Disconnected = "disconnected"
+}
 export interface OutgoingMessageInterface {
     encoder: Encoder;
     type?: MessageType;
@@ -32,6 +40,31 @@ export interface Constructable<T> {
     new (...args: any): T;
 }
 export declare type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
+export declare type onAuthenticationFailedParameters = {
+    reason: string;
+};
+export declare type onOpenParameters = {
+    event: Event;
+};
+export declare type onMessageParameters = {
+    event: MessageEvent;
+    message: IncomingMessage;
+};
+export declare type onOutgoingMessageParameters = {
+    message: OutgoingMessage;
+};
+export declare type onStatusParameters = {
+    status: WebSocketStatus;
+};
+export declare type onSyncedParameters = {
+    state: boolean;
+};
+export declare type onDisconnectParameters = {
+    event: CloseEvent;
+};
+export declare type onCloseParameters = {
+    event: CloseEvent;
+};
 export declare type onAwarenessUpdateParameters = {
     states: StatesArray;
 };

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
-import { Configuration, Hook } from './types';
+import { Configuration, HookName, HookPayload } from './types';
 import Document from './Document';
 import { Debugger } from './Debugger';
 import { onListenPayload } from '.';
@@ -88,7 +88,7 @@ export declare class Hocuspocus {
      * Run the given hook on all configured extensions.
      * Runs the given callback after each hook.
      */
-    hooks(name: Hook, payload: any, callback?: Function | null): Promise<any>;
+    hooks(name: HookName, payload: HookPayload, callback?: Function | null): Promise<any>;
     /**
      * Get parameters by the given request
      */

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

@@ -1,9 +1,8 @@
-export * from './Hocuspocus';
 export * from './Connection';
+export * from './Debugger';
 export * from './Document';
+export * from './Hocuspocus';
 export * from './IncomingMessage';
+export * from './MessageReceiver';
 export * from './OutgoingMessage';
 export * from './types';
-export * from './MessageReceiver';
-export * from './Document';
-export * from './Connection';

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

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
 import { URLSearchParams } from 'url';
-import { Socket } from 'net';
 import { Awareness } from 'y-protocols/awareness';
 import Document from './Document';
 import { Hocuspocus } from './Hocuspocus';
@@ -44,11 +43,12 @@ export interface Extension {
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type Hook = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
+export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
 /**
  * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
  */
 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onLoadDocumentPayload | onLoadDocumentPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
 export interface Configuration extends Extension {
     /**
      * A name for the instance, used for logging.
@@ -198,20 +198,21 @@ export interface onRequestPayload {
     instance: Hocuspocus;
 }
 export interface onUpgradePayload {
-    head: any;
     request: IncomingMessage;
-    socket: Socket;
+    socket: any;
+    head: any;
     instance: Hocuspocus;
 }
 export interface onListenPayload {
+    instance: Hocuspocus;
+    configuration: Configuration;
     port: number;
 }
 export interface onDestroyPayload {
     instance: Hocuspocus;
 }
 export interface onConfigurePayload {
+    instance: Hocuspocus;
     configuration: Configuration;
     version: string;
-    yjsVersion: string;
-    instance: Hocuspocus;
 }

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

@@ -2,6 +2,7 @@ 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/randomInteger.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.33",
+  "version": "1.0.0-alpha.36",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -11,7 +11,7 @@
   ],
   "license": "MIT",
   "type": "module",
-  "main": "dist/hocuspocus-provider.esm.js",
+  "main": "dist/hocuspocus-provider.cjs",
   "module": "dist/hocuspocus-provider.esm.js",
   "types": "dist/packages/provider/src/index.d.ts",
   "exports": {
@@ -28,11 +28,11 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^1.0.0-alpha.8",
+    "@hocuspocus/common": "^1.0.0-alpha.11",
     "@lifeomic/attempt": "^3.0.2",
-    "lib0": "^0.2.43",
+    "lib0": "^0.2.46",
     "y-protocols": "^1.0.5",
-    "yjs": "^13.5.24"
+    "yjs": "^13.5.29"
   },
-  "gitHead": "771a8cbad1016dd12080ff4b35fabb9680ec69a7"
+  "gitHead": "b0a04ffe8d56cfa6b269a2c8ad7f64c92b108de0"
 }

package/src/HocuspocusProvider.ts

@@ -19,16 +19,11 @@ import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage'
 import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage'
 import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage'
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage'
-import { OutgoingMessage } from './OutgoingMessage'
-import { ConstructableOutgoingMessage } from './types'
+import {
+  ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, onSyncedParameters, WebSocketStatus,
+} from './types'
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.'
 
-export enum WebSocketStatus {
-  Connecting = 'connecting',
-  Connected = 'connected',
-  Disconnected = 'disconnected',
-}
-
 export type HocuspocusProviderConfiguration =
   Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>>
   & Partial<CompleteHocuspocusProviderConfiguration>
@@ -111,18 +106,18 @@ export interface CompleteHocuspocusProviderConfiguration {
    */
   timeout: number,
   onAuthenticated: () => void,
-  onAuthenticationFailed: ({ reason }: { reason: string }) => void,
-  onOpen: (event: Event) => void,
+  onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void,
+  onOpen: (data: onOpenParameters) => void,
   onConnect: () => void,
-  onMessage: (event: MessageEvent) => void,
-  onOutgoingMessage: (message: OutgoingMessage) => void,
-  onStatus: (status: any) => void,
-  onSynced: ({ state }: { state: boolean }) => void,
-  onDisconnect: (event: CloseEvent) => void,
-  onClose: (event: CloseEvent) => void,
+  onMessage: (data: onMessageParameters) => void,
+  onOutgoingMessage: (data: onOutgoingMessageParameters) => void,
+  onStatus: (data: onStatusParameters) => void,
+  onSynced: (data: onSyncedParameters) => void,
+  onDisconnect: (data: onDisconnectParameters) => void,
+  onClose: (data: onCloseParameters) => void,
   onDestroy: () => void,
-  onAwarenessUpdate: ({ states }: onAwarenessUpdateParameters) => void,
-  onAwarenessChange: ({ states }: onAwarenessChangeParameters) => void,
+  onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void,
+  onAwarenessChange: (data: onAwarenessChangeParameters) => void,
   /**
    * Don’t output any warnings.
    */
@@ -313,7 +308,7 @@ export class HocuspocusProvider extends EventEmitter {
       // Reset the status
       this.synced = false
       this.status = WebSocketStatus.Connecting
-      this.emit('status', { status: 'connecting' })
+      this.emit('status', { status: WebSocketStatus.Connecting })
 
       // Store resolve/reject for later use
       this.connectionAttempt = {
@@ -328,7 +323,7 @@ export class HocuspocusProvider extends EventEmitter {
     this.connectionAttempt = null
 
     this.status = WebSocketStatus.Connected
-    this.emit('status', { status: 'connected' })
+    this.emit('status', { status: WebSocketStatus.Connected })
     this.emit('connect')
   }
 
@@ -541,7 +536,7 @@ export class HocuspocusProvider extends EventEmitter {
       )
 
       this.status = WebSocketStatus.Disconnected
-      this.emit('status', { status: 'disconnected' })
+      this.emit('status', { status: WebSocketStatus.Disconnected })
       this.emit('disconnect', { event })
     }
 
@@ -579,7 +574,7 @@ export class HocuspocusProvider extends EventEmitter {
 
     // Let’s update the connection status.
     this.status = WebSocketStatus.Disconnected
-    this.emit('status', { status: 'disconnected' })
+    this.emit('status', { status: WebSocketStatus.Disconnected })
     this.emit('disconnect', { event })
   }
 

package/src/types.ts

@@ -1,12 +1,15 @@
 import { Awareness } from 'y-protocols/awareness'
 import * as Y from 'yjs'
 import { Encoder } from 'lib0/encoding'
+import type { Event, CloseEvent, MessageEvent } from 'ws'
 import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage'
 import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage'
 import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage'
 import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage'
 import { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage'
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage'
+import { IncomingMessage } from './IncomingMessage'
+import { OutgoingMessage } from './OutgoingMessage'
 
 export enum MessageType {
   Sync = 0,
@@ -15,6 +18,12 @@ export enum MessageType {
   QueryAwareness = 3,
 }
 
+export enum WebSocketStatus {
+  Connecting = 'connecting',
+  Connected = 'connected',
+  Disconnected = 'disconnected',
+}
+
 export interface OutgoingMessageInterface {
   encoder: Encoder
   type?: MessageType
@@ -42,6 +51,39 @@ export type ConstructableOutgoingMessage =
   Constructable<SyncStepTwoMessage> |
   Constructable<UpdateMessage>
 
+export type onAuthenticationFailedParameters = {
+  reason: string,
+}
+
+export type onOpenParameters = {
+  event: Event,
+}
+
+export type onMessageParameters = {
+  event: MessageEvent,
+  message: IncomingMessage,
+}
+
+export type onOutgoingMessageParameters = {
+  message: OutgoingMessage,
+}
+
+export type onStatusParameters = {
+  status: WebSocketStatus,
+}
+
+export type onSyncedParameters = {
+  state: boolean,
+}
+
+export type onDisconnectParameters = {
+  event: CloseEvent,
+}
+
+export type onCloseParameters = {
+  event: CloseEvent,
+}
+
 export type onAwarenessUpdateParameters = {
   states: StatesArray
 }

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/tests/extension-redis/onLoadDocument.d.ts

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

package/dist/tests/extension-redis/onSynced.d.ts

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