@hocuspocus/provider 1.0.2 → 1.1.0

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

@@ -1,6 +1,7 @@
-import RedisClient from 'ioredis';
+import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
 import Redlock from 'redlock';
-import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, onListenPayload } from '@hocuspocus/server';
+import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, onListenPayload, beforeBroadcastStatelessPayload } from '@hocuspocus/server';
+export declare type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
 export interface Configuration {
     /**
      * Redis port
@@ -10,12 +11,24 @@ export interface Configuration {
      * 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?: RedisClient.RedisOptions;
+    options?: ClusterOptions | RedisOptions;
     /**
      * An unique instance name, required to filter messages in Redis.
      * If none is provided an unique id is generated.
@@ -38,8 +51,8 @@ export declare class Redis implements Extension {
      */
     priority: number;
     configuration: Configuration;
-    pub: RedisClient.Redis;
-    sub: RedisClient.Redis;
+    pub: RedisInstance;
+    sub: RedisInstance;
     documents: Map<string, Document>;
     redlock: Redlock;
     locks: Map<string, Redlock.Lock>;
@@ -91,6 +104,7 @@ export declare class Redis implements Extension {
      * noone connected anymore.
      */
     onDisconnect: ({ documentName, clientsCount }: onDisconnectPayload) => Promise<void>;
+    beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
     /**
      * Kill the Redlock connection immediately.
      */

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

@@ -3,7 +3,7 @@ import { Awareness } from 'y-protocols/awareness';
 import * as mutex from 'lib0/mutex';
 import type { Event, CloseEvent, MessageEvent } from 'ws';
 import EventEmitter from './EventEmitter';
-import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
+import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
 export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
 export interface CompleteHocuspocusProviderConfiguration {
@@ -98,6 +98,7 @@ export interface CompleteHocuspocusProviderConfiguration {
     onDestroy: () => void;
     onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
     onAwarenessChange: (data: onAwarenessChangeParameters) => void;
+    onStateless: (data: onStatelessParameters) => void;
     /**
      * Don’t output any warnings.
      */
@@ -136,6 +137,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     boundBeforeUnload: () => void;
     beforeUnload(): void;
     registerEventListeners(): void;
+    sendStateless(payload: string): void;
     documentUpdateHandler(update: Uint8Array, origin: any): void;
     awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
     permissionDeniedHandler(reason: string): void;
@@ -144,6 +146,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     get url(): string;
     get synced(): boolean;
     set synced(state: boolean);
+    receiveStateless(payload: string): void;
     get isAuthenticationRequired(): boolean;
     disconnect(): void;
     onOpen(event: Event): Promise<void>;

package/dist/packages/provider/src/OutgoingMessages/StatelessMessage.d.ts

@@ -0,0 +1,7 @@
+import { MessageType, OutgoingMessageArguments } from '../types';
+import { OutgoingMessage } from '../OutgoingMessage';
+export declare class StatelessMessage extends OutgoingMessage {
+    type: MessageType;
+    description: string;
+    get(args: Partial<OutgoingMessageArguments>): import("lib0/encoding").Encoder;
+}

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

@@ -14,7 +14,8 @@ export declare enum MessageType {
     Sync = 0,
     Awareness = 1,
     Auth = 2,
-    QueryAwareness = 3
+    QueryAwareness = 3,
+    Stateless = 5
 }
 export declare enum WebSocketStatus {
     Connecting = "connecting",
@@ -34,6 +35,7 @@ export interface OutgoingMessageArguments {
         [key: string]: any;
     }>;
     update: any;
+    payload: string;
     encoder: Encoder;
 }
 export interface Constructable<T> {
@@ -71,6 +73,9 @@ export declare type onAwarenessUpdateParameters = {
 export declare type onAwarenessChangeParameters = {
     states: StatesArray;
 };
+export declare type onStatelessParameters = {
+    payload: string;
+};
 export declare type StatesArray = {
     clientId: number;
     [key: string | number]: any;

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

@@ -5,6 +5,7 @@ import { IncomingMessage as HTTPIncomingMessage } from 'http';
 import { CloseEvent } from '@hocuspocus/common';
 import Document from './Document';
 import { Debugger } from './Debugger';
+import { onStatelessPayload } from './types';
 export declare class Connection {
     webSocket: WebSocket;
     context: any;
@@ -26,6 +27,10 @@ export declare class Connection {
      * Set a callback that will be triggered when the connection is closed
      */
     onClose(callback: (document: Document) => void): Connection;
+    /**
+     * Set a callback that will be triggered when an stateless message is received
+     */
+    onStatelessCallback(callback: (payload: onStatelessPayload) => Promise<void>): Connection;
     /**
      * Set a callback that will be triggered before an message is handled
      */
@@ -34,6 +39,10 @@ export declare class Connection {
      * Send the given message
      */
     send(message: any): void;
+    /**
+     * Send a stateless message with payload
+     */
+    sendStateless(payload: string): void;
     /**
      * Graceful wrapper around the WebSocket close method.
      */

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

@@ -8,6 +8,7 @@ export declare class Document extends Doc {
     awareness: Awareness;
     callbacks: {
         onUpdate: (document: Document, connection: Connection, update: Uint8Array) => void;
+        beforeBroadcastStateless: (document: Document, stateless: string) => void;
     };
     connections: Map<WebSocket, {
         clients: Set<any>;
@@ -33,6 +34,10 @@ export declare class Document extends Doc {
      * Set a callback that will be triggered when the document is updated
      */
     onUpdate(callback: (document: Document, connection: Connection, update: Uint8Array) => void): Document;
+    /**
+     * Set a callback that will be triggered before a stateless message is broadcasted
+     */
+    beforeBroadcastStateless(callback: (document: Document, stateless: string) => void): Document;
     /**
      * Register a connection and a set of clients on this document keyed by the
      * underlying websocket connection
@@ -75,5 +80,9 @@ export declare class Document extends Doc {
      * Handle an updated document and sync changes to clients
      */
     private handleUpdate;
+    /**
+     * Broadcast stateless message to all connections
+     */
+    broadcastStateless(payload: string): void;
 }
 export default Document;

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

@@ -13,6 +13,7 @@ export declare class IncomingMessage {
     constructor(input: any);
     readVarUint8Array(): Uint8Array;
     readVarUint(): number;
+    readVarString(): string;
     toUint8Array(): Uint8Array;
     writeVarUint(type: MessageType): void;
     get length(): number;

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

@@ -14,5 +14,7 @@ export declare class OutgoingMessage {
     writePermissionDenied(reason: string): OutgoingMessage;
     writeFirstSyncStepFor(document: Document): OutgoingMessage;
     writeUpdate(update: Uint8Array): OutgoingMessage;
+    writeStateless(payload: string): OutgoingMessage;
+    writeBroadcastStateless(payload: string): OutgoingMessage;
     toUint8Array(): Uint8Array;
 }

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

@@ -4,13 +4,16 @@ import { URLSearchParams } from 'url';
 import { Awareness } from 'y-protocols/awareness';
 import Document from './Document';
 import { Hocuspocus } from './Hocuspocus';
+import Connection from './Connection';
 export declare enum MessageType {
     Unknown = -1,
     Sync = 0,
     Awareness = 1,
     Auth = 2,
     QueryAwareness = 3,
-    SyncReply = 4
+    SyncReply = 4,
+    Stateless = 5,
+    BroadcastStateless = 6
 }
 export interface AwarenessUpdate {
     added: Array<any>;
@@ -33,6 +36,8 @@ export interface Extension {
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     afterLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
+    beforeBroadcastStateless?(data: beforeBroadcastStatelessPayload): Promise<any>;
+    onStateless?(payload: onStatelessPayload): Promise<any>;
     onChange?(data: onChangePayload): Promise<any>;
     onStoreDocument?(data: onStoreDocumentPayload): Promise<any>;
     afterStoreDocument?(data: afterStoreDocumentPayload): Promise<any>;
@@ -41,8 +46,8 @@ export interface Extension {
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
-export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
+export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onStatelessPayload | beforeHandleMessagePayload | beforeBroadcastStatelessPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
 export interface Configuration extends Extension {
     /**
      * A name for the instance, used for logging.
@@ -94,6 +99,12 @@ export interface getDocumentNamePayload {
     request: IncomingMessage;
     requestParameters: URLSearchParams;
 }
+export interface onStatelessPayload {
+    connection: Connection;
+    documentName: string;
+    document: Document;
+    payload: string;
+}
 export interface onAuthenticatePayload {
     documentName: string;
     instance: Hocuspocus;
@@ -163,6 +174,11 @@ export interface beforeHandleMessagePayload {
     update: Uint8Array;
     socketId: string;
 }
+export interface beforeBroadcastStatelessPayload {
+    document: Document;
+    documentName: string;
+    payload: string;
+}
 export interface onStoreDocumentPayload {
     clientsCount: number;
     context: any;

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

@@ -1,5 +1,5 @@
 import { Doc } from 'yjs';
-import { Schema } from 'prosemirror-model';
+import { Schema } from '@tiptap/pm/model';
 import { Transformer } from './types';
 declare class Prosemirror implements Transformer {
     defaultSchema: Schema;

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

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

package/dist/tests/provider/onStateless.d.ts

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

package/dist/tests/server/beforeBroadcastStateless.d.ts

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

package/dist/tests/server/onStateless.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,7 +28,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^1.0.2",
+    "@hocuspocus/common": "^1.1.0",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.46"
   },

package/src/HocuspocusProvider.ts

@@ -20,9 +20,10 @@ import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage'
 import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage'
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage'
 import {
-  ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, onSyncedParameters, WebSocketStatus,
+  ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, WebSocketStatus,
 } from './types'
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.'
+import { StatelessMessage } from './OutgoingMessages/StatelessMessage'
 
 export type HocuspocusProviderConfiguration =
   Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>>
@@ -118,6 +119,8 @@ export interface CompleteHocuspocusProviderConfiguration {
   onDestroy: () => void,
   onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void,
   onAwarenessChange: (data: onAwarenessChangeParameters) => void,
+  onStateless: (data: onStatelessParameters) => void
+
   /**
    * Don’t output any warnings.
    */
@@ -169,6 +172,7 @@ export class HocuspocusProvider extends EventEmitter {
     onDestroy: () => null,
     onAwarenessUpdate: () => null,
     onAwarenessChange: () => null,
+    onStateless: () => null,
     quiet: false,
   }
 
@@ -221,6 +225,7 @@ export class HocuspocusProvider extends EventEmitter {
     this.on('destroy', this.configuration.onDestroy)
     this.on('awarenessUpdate', this.configuration.onAwarenessUpdate)
     this.on('awarenessChange', this.configuration.onAwarenessChange)
+    this.on('stateless', this.configuration.onStateless)
 
     this.awareness.on('update', () => {
       this.emit('awarenessUpdate', { states: awarenessStatesToArray(this.awareness.getStates()) })
@@ -424,6 +429,10 @@ export class HocuspocusProvider extends EventEmitter {
     window.addEventListener('beforeunload', this.boundBeforeUnload)
   }
 
+  sendStateless(payload: string) {
+    this.send(StatelessMessage, { payload })
+  }
+
   documentUpdateHandler(update: Uint8Array, origin: any) {
     if (origin === this) {
       return
@@ -484,6 +493,10 @@ export class HocuspocusProvider extends EventEmitter {
     this.emit('sync', { state })
   }
 
+  receiveStateless(payload: string) {
+    this.emit('stateless', { payload })
+  }
+
   get isAuthenticationRequired(): boolean {
     return !!this.configuration.token && !this.isAuthenticated
   }

package/src/MessageReceiver.ts

@@ -1,6 +1,7 @@
 import * as awarenessProtocol from 'y-protocols/awareness'
 import { readSyncMessage, messageYjsSyncStep2, messageYjsUpdate } from 'y-protocols/sync'
 import { readAuthMessage } from '@hocuspocus/common'
+import { readVarString } from 'lib0/decoding'
 import { MessageType } from './types'
 import { HocuspocusProvider } from './HocuspocusProvider'
 import { IncomingMessage } from './IncomingMessage'
@@ -43,6 +44,10 @@ export class MessageReceiver {
         this.applyQueryAwarenessMessage(provider)
         break
 
+      case MessageType.Stateless:
+        provider.receiveStateless(readVarString(message.decoder))
+        break
+
       default:
         throw new Error(`Can’t apply message of unknown type: ${type}`)
     }

package/src/OutgoingMessages/StatelessMessage.ts

@@ -0,0 +1,16 @@
+import { writeVarString, writeVarUint } from 'lib0/encoding'
+import { MessageType, OutgoingMessageArguments } from '../types'
+import { OutgoingMessage } from '../OutgoingMessage'
+
+export class StatelessMessage extends OutgoingMessage {
+  type = MessageType.Stateless
+
+  description = 'A stateless message'
+
+  get(args: Partial<OutgoingMessageArguments>) {
+    writeVarUint(this.encoder, this.type)
+    writeVarString(this.encoder, args.payload ?? '')
+
+    return this.encoder
+  }
+}

package/src/types.ts

@@ -16,6 +16,7 @@ export enum MessageType {
   Awareness = 1,
   Auth = 2,
   QueryAwareness = 3,
+  Stateless = 5,
 }
 
 export enum WebSocketStatus {
@@ -36,6 +37,7 @@ export interface OutgoingMessageArguments {
   clients: number[],
   states: Map<number, { [key: string]: any; }>,
   update: any,
+  payload: string,
   encoder: Encoder,
 }
 
@@ -92,4 +94,8 @@ export type onAwarenessChangeParameters = {
   states: StatesArray
 }
 
+export type onStatelessParameters = {
+  payload: string
+}
+
 export type StatesArray = { clientId: number, [key: string | number]: any }[]