@hocuspocus/provider 1.0.0-alpha.32 → 1.0.0-alpha.35

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

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

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

@@ -0,0 +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
+}

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;
@@ -56,7 +55,6 @@ export declare class Collector {
         platform: NodeJS.Platform;
         started: string;
         version: string;
-        yjsVersion: string;
     }>;
     private static readableYDoc;
 }

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload, connectedPayload } from '@hocuspocus/server';
 import { IncomingMessage, ServerResponse } from 'http';
 import WebSocket from 'ws';
 import { Storage } from './Storage';
@@ -30,7 +30,7 @@ export declare class Monitor implements Extension {
     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>;
+    connected(data: connectedPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
     onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;

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.
      */
@@ -133,6 +123,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     connect(): Promise<void>;
     createWebSocketConnection(): Promise<unknown>;
     resolveConnectionAttempt(): void;
+    stopConnectionAttempt(): void;
     rejectConnectionAttempt(): void;
     get document(): Y.Doc;
     get awareness(): Awareness;
@@ -149,9 +140,8 @@ export declare class HocuspocusProvider extends EventEmitter {
     set synced(state: boolean);
     get isAuthenticationRequired(): boolean;
     disconnect(): void;
-    onOpen(event: Event): void;
+    onOpen(event: Event): Promise<void>;
     getToken(): Promise<string | null>;
-    webSocketConnectionEstablished(): Promise<void>;
     startSync(): void;
     send(Message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
     onMessage(event: MessageEvent): void;

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

@@ -12,16 +12,6 @@ export declare enum MessageType {
     Auth = 2,
     QueryAwareness = 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
-}
 export interface AwarenessUpdate {
     added: Array<any>;
     updated: Array<any>;
@@ -222,6 +212,5 @@ export interface onDestroyPayload {
 export interface onConfigurePayload {
     configuration: Configuration;
     version: string;
-    yjsVersion: string;
     instance: Hocuspocus;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.32",
+  "version": "1.0.0-alpha.35",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,11 +28,11 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^1.0.0-alpha.7",
+    "@hocuspocus/common": "^1.0.0-alpha.10",
     "@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": "41c2ca3452f17e7dab914c633cde04ae68f45929"
+  "gitHead": "1fc2a6cff1b5fd626b8dd7c486755111965da20d"
 }

package/src/HocuspocusProvider.ts

@@ -6,7 +6,9 @@ import * as mutex from 'lib0/mutex'
 import * as url from 'lib0/url'
 import type { Event, CloseEvent, MessageEvent } from 'ws'
 import { retry } from '@lifeomic/attempt'
-import { awarenessStatesToArray, Forbidden, Unauthorized } from '@hocuspocus/common'
+import {
+  awarenessStatesToArray, Forbidden, Unauthorized, WsReadyStates,
+} from '@hocuspocus/common'
 import EventEmitter from './EventEmitter'
 import { IncomingMessage } from './IncomingMessage'
 import { MessageReceiver } from './MessageReceiver'
@@ -17,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>
@@ -109,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.
    */
@@ -311,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 = {
@@ -324,6 +321,14 @@ export class HocuspocusProvider extends EventEmitter {
   resolveConnectionAttempt() {
     this.connectionAttempt?.resolve()
     this.connectionAttempt = null
+
+    this.status = WebSocketStatus.Connected
+    this.emit('status', { status: WebSocketStatus.Connected })
+    this.emit('connect')
+  }
+
+  stopConnectionAttempt() {
+    this.connectionAttempt = null
   }
 
   rejectConnectionAttempt() {
@@ -457,12 +462,17 @@ export class HocuspocusProvider extends EventEmitter {
     }
   }
 
-  onOpen(event: Event) {
+  async onOpen(event: Event) {
     this.emit('open', { event })
 
-    if (this.status !== WebSocketStatus.Connected) {
-      this.webSocketConnectionEstablished()
+    if (this.isAuthenticationRequired) {
+      this.send(AuthenticationMessage, {
+        token: await this.getToken(),
+      })
+      return
     }
+
+    this.startSync()
   }
 
   async getToken() {
@@ -474,21 +484,6 @@ export class HocuspocusProvider extends EventEmitter {
     return this.configuration.token
   }
 
-  async webSocketConnectionEstablished() {
-    this.status = WebSocketStatus.Connected
-    this.emit('status', { status: 'connected' })
-    this.emit('connect')
-
-    if (this.isAuthenticationRequired) {
-      this.send(AuthenticationMessage, {
-        token: await this.getToken(),
-      })
-      return
-    }
-
-    this.startSync()
-  }
-
   startSync() {
     this.send(SyncStepOneMessage, { document: this.document })
 
@@ -505,7 +500,7 @@ export class HocuspocusProvider extends EventEmitter {
       this.mux(() => { this.broadcast(Message, args) })
     }
 
-    if (this.status === WebSocketStatus.Connected) {
+    if (this.webSocket?.readyState === WsReadyStates.Open) {
       const messageSender = new MessageSender(Message, args)
 
       this.emit('outgoingMessage', { message: messageSender.message })
@@ -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 })
   }
 
@@ -594,10 +589,10 @@ export class HocuspocusProvider extends EventEmitter {
 
     removeAwarenessStates(this.awareness, [this.document.clientID], 'provider destroy')
 
-    // If there is still a connection attempt outstanding then we should resolve
+    // If there is still a connection attempt outstanding then we should stop
     // it before calling disconnect, otherwise it will be rejected in the onClose
     // handler and trigger a retry
-    this.resolveConnectionAttempt()
+    this.stopConnectionAttempt()
 
     this.disconnect()
 

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
 }