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

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

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

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

@@ -1,2 +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/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/extension-throttle/src/index.d.ts

@@ -1,12 +1,16 @@
 import { Extension, onConnectPayload } from '@hocuspocus/server';
-export interface Configuration {
+export interface ThrottleConfiguration {
     throttle: number | null | false;
     banTime: number;
 }
 export declare class Throttle implements Extension {
-    configuration: Configuration;
+    configuration: ThrottleConfiguration;
     connectionsByIp: Map<string, Array<number>>;
     bannedIps: Map<string, number>;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<ThrottleConfiguration>);
     /**
      * Throttle requests
      * @private

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

@@ -133,6 +133,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 +150,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/index.d.ts

@@ -1,4 +1,3 @@
 export * from './HocuspocusProvider';
 export * from './HocuspocusCloudProvider';
 export * from './types';
-export * from './utils';

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

@@ -8,6 +8,6 @@ export declare class MessageReceiver {
     logger: Debugger;
     constructor(message: IncomingMessage, logger: Debugger);
     apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
-    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): 0 | 1 | 2;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): 0 | 2 | 1;
     applyQueryAwarenessMessage(awareness: Awareness, reply?: (message: Uint8Array) => void): void;
 }

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>;
@@ -38,6 +28,7 @@ export interface Extension {
     onListen?(data: onListenPayload): Promise<any>;
     onUpgrade?(data: onUpgradePayload): Promise<any>;
     onConnect?(data: onConnectPayload): Promise<any>;
+    connected?(data: connectedPayload): Promise<any>;
     onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
     /**
      * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
@@ -53,7 +44,7 @@ export interface Extension {
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type Hook = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'onAuthenticate' | 
+export declare type Hook = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
 /**
  * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
  */
@@ -116,6 +107,15 @@ export interface onConnectPayload {
     socketId: string;
     connection: ConnectionConfiguration;
 }
+export interface connectedPayload {
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
 export interface onLoadDocumentPayload {
     context: any;
     document: Document;

package/dist/tests/extension-throttle/configuration.d.ts

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

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.30",
+  "version": "1.0.0-alpha.33",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,11 +28,11 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^1.0.0-alpha.5",
+    "@hocuspocus/common": "^1.0.0-alpha.8",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.43",
     "y-protocols": "^1.0.5",
     "yjs": "^13.5.24"
   },
-  "gitHead": "125d94dc3520bb5185293c9b316f66ddd9215992"
+  "gitHead": "771a8cbad1016dd12080ff4b35fabb9680ec69a7"
 }

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 { 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'
@@ -18,8 +20,7 @@ import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage'
 import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage'
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage'
 import { OutgoingMessage } from './OutgoingMessage'
-import awarenessStatesToArray from './utils/awarenessStatesToArray'
-import { ConstructableOutgoingMessage, StatesArray } from './types'
+import { ConstructableOutgoingMessage } from './types'
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.'
 
 export enum WebSocketStatus {
@@ -325,6 +326,14 @@ export class HocuspocusProvider extends EventEmitter {
   resolveConnectionAttempt() {
     this.connectionAttempt?.resolve()
     this.connectionAttempt = null
+
+    this.status = WebSocketStatus.Connected
+    this.emit('status', { status: 'connected' })
+    this.emit('connect')
+  }
+
+  stopConnectionAttempt() {
+    this.connectionAttempt = null
   }
 
   rejectConnectionAttempt() {
@@ -458,12 +467,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() {
@@ -475,21 +489,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 })
 
@@ -506,7 +505,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 })
@@ -595,10 +594,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/index.ts

@@ -1,4 +1,3 @@
 export * from './HocuspocusProvider'
 export * from './HocuspocusCloudProvider'
 export * from './types'
-export * from './utils'

package/dist/packages/provider/src/utils/awarenessStatesToArray.d.ts

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

package/dist/packages/provider/src/utils/index.d.ts

@@ -1 +0,0 @@
-export { default as awarenessStatesToArray } from './awarenessStatesToArray';

package/src/utils/awarenessStatesToArray.ts

@@ -1,8 +0,0 @@
-export default (states: Map<number, Record<string, any>>) => {
-  return Array.from(states.entries()).map(([key, value]) => {
-    return {
-      clientId: key,
-      ...value,
-    }
-  })
-}

package/src/utils/index.ts

@@ -1 +0,0 @@
-export { default as awarenessStatesToArray } from './awarenessStatesToArray'