@hocuspocus/provider 2.0.0-alpha.0 → 2.0.0-beta.0

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

@@ -2,7 +2,6 @@
 import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
 import { Doc } from 'yjs';
 import { Transformer } from '@hocuspocus/transformer';
-import { AxiosResponse } from 'axios';
 export declare enum Events {
     onChange = "change",
     onConnect = "connect",
@@ -41,7 +40,7 @@ export declare class Webhook implements Extension {
     /**
      * Send a request to the given url containing the given data
      */
-    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any, any>>;
+    sendRequest(event: Events, payload: any): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * onChange hook
      */

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

@@ -4,9 +4,9 @@ import * as mutex from 'lib0/mutex';
 import type { CloseEvent, Event, MessageEvent } from 'ws';
 import EventEmitter from './EventEmitter';
 import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
-import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket';
+import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket';
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
-export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name' | 'websocketProvider'>> & Partial<CompleteHocuspocusProviderConfiguration>;
+export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> | Required<Pick<CompleteHocuspocusProviderConfiguration, 'websocketProvider'>>);
 export interface CompleteHocuspocusProviderConfiguration {
     /**
      * The identifier/name of your document
@@ -70,6 +70,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     isAuthenticated: boolean;
     mux: mutex.mutex;
     intervals: any;
+    isConnected: boolean;
     constructor(configuration: HocuspocusProviderConfiguration);
     onStatus({ status }: onStatusParameters): void;
     setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
@@ -87,6 +88,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     set synced(state: boolean);
     receiveStateless(payload: string): void;
     get isAuthenticationRequired(): boolean;
+    connect(): Promise<unknown>;
     disconnect(): void;
     onOpen(event: Event): Promise<void>;
     getToken(): Promise<string | null>;

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

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

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

@@ -15,7 +15,8 @@ export declare enum MessageType {
     Awareness = 1,
     Auth = 2,
     QueryAwareness = 3,
-    Stateless = 5
+    Stateless = 5,
+    CLOSE = 7
 }
 export declare enum WebSocketStatus {
     Connecting = "connecting",

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

@@ -23,10 +23,14 @@ export declare class Connection {
      * Constructor.
      */
     constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly: boolean | undefined, logger: Debugger);
+    boundClose: (event?: CloseEvent | undefined) => void;
+    boundHandleMessage: (data: Uint8Array) => void;
+    boundHandlePong: () => void;
+    handlePong(): void;
     /**
      * Set a callback that will be triggered when the connection is closed
      */
-    onClose(callback: (document: Document) => void): Connection;
+    onClose(callback: (document: Document, event?: CloseEvent) => void): Connection;
     /**
      * Set a callback that will be triggered when an stateless message is received
      */

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

@@ -13,7 +13,8 @@ export declare enum MessageType {
     QueryAwareness = 3,
     SyncReply = 4,
     Stateless = 5,
-    BroadcastStateless = 6
+    BroadcastStateless = 6,
+    CLOSE = 7
 }
 export interface AwarenessUpdate {
     added: Array<any>;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-beta.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,9 +28,10 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^2.0.0-alpha.0",
+    "@hocuspocus/common": "^2.0.0-beta.0",
     "@lifeomic/attempt": "^3.0.2",
-    "lib0": "^0.2.47"
+    "lib0": "^0.2.47",
+    "ws": "^7.5.9"
   },
   "peerDependencies": {
     "y-protocols": "^1.0.5",

package/src/HocuspocusProvider.ts

@@ -26,13 +26,20 @@ import {
   onSyncedParameters,
   WebSocketStatus,
 } from './types'
-import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket'
+import {
+  CompleteHocuspocusProviderWebsocketConfiguration,
+  HocuspocusProviderWebsocket,
+} from './HocuspocusProviderWebsocket'
 import { StatelessMessage } from './OutgoingMessages/StatelessMessage'
+import { CloseMessage } from './OutgoingMessages/CloseMessage'
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.'
 
 export type HocuspocusProviderConfiguration =
-  Required<Pick<CompleteHocuspocusProviderConfiguration, 'name' | 'websocketProvider'>>
-  & Partial<CompleteHocuspocusProviderConfiguration>
+  Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>>
+    & Partial<CompleteHocuspocusProviderConfiguration> & (
+  Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> |
+  Required<Pick<CompleteHocuspocusProviderConfiguration, 'websocketProvider'>>
+  )
 
 export interface CompleteHocuspocusProviderConfiguration {
    /**
@@ -134,6 +141,8 @@ export class HocuspocusProvider extends EventEmitter {
     forceSync: null,
   }
 
+  isConnected = true
+
   constructor(configuration: HocuspocusProviderConfiguration) {
     super()
     this.setConfiguration(configuration)
@@ -203,6 +212,10 @@ export class HocuspocusProvider extends EventEmitter {
   }
 
   public setConfiguration(configuration: Partial<HocuspocusProviderConfiguration> = {}): void {
+    if (!configuration.websocketProvider && (configuration as CompleteHocuspocusProviderWebsocketConfiguration).url) {
+      this.configuration.websocketProvider = new HocuspocusProviderWebsocket({ url: (configuration as CompleteHocuspocusProviderWebsocketConfiguration).url })
+    }
+
     this.configuration = { ...this.configuration, ...configuration }
   }
 
@@ -281,6 +294,11 @@ export class HocuspocusProvider extends EventEmitter {
     return !!this.configuration.token && !this.isAuthenticated
   }
 
+  // not needed, but provides backward compatibility with e.g. lexicla/yjs
+  async connect() {
+    return this.configuration.websocketProvider.connect()
+  }
+
   disconnect() {
     this.disconnectBroadcastChannel()
     this.configuration.websocketProvider.detach(this)
@@ -294,7 +312,6 @@ export class HocuspocusProvider extends EventEmitter {
         token: await this.getToken(),
         documentName: this.configuration.name,
       })
-      return
     }
 
     this.startSync()
@@ -322,6 +339,8 @@ export class HocuspocusProvider extends EventEmitter {
   }
 
   send(message: ConstructableOutgoingMessage, args: any, broadcast = false) {
+    if (!this.isConnected) return
+
     if (broadcast) {
       this.mux(() => { this.broadcast(message, args) })
     }
@@ -376,6 +395,9 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.removeAllListeners()
 
+    this.send(CloseMessage, { documentName: this.configuration.name })
+    this.isConnected = false
+
     if (typeof window === 'undefined') {
       return
     }

package/src/HocuspocusProviderWebsocket.ts

@@ -409,8 +409,10 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     }
 
     if (event.code === Unauthorized.code) {
-      if (!this.configuration.quiet) {
+      if (event.reason === Unauthorized.reason) {
         console.warn('[HocuspocusProvider] An authentication token is required, but you didn’t send one. Try adding a `token` to your HocuspocusProvider configuration. Won’t try again.')
+      } else {
+        console.warn(`[HocuspocusProvider] Connection closed with status Unauthorized: ${event.reason}`)
       }
 
       this.shouldConnect = false

package/src/OutgoingMessages/CloseMessage.ts

@@ -0,0 +1,16 @@
+import * as encoding from 'lib0/encoding'
+import { MessageType, OutgoingMessageArguments } from '../types'
+import { OutgoingMessage } from '../OutgoingMessage'
+
+export class CloseMessage extends OutgoingMessage {
+  type = MessageType.CLOSE
+
+  description = 'Ask the server to close the connection'
+
+  get(args: Partial<OutgoingMessageArguments>) {
+    encoding.writeVarString(this.encoder, args.documentName!)
+    encoding.writeVarUint(this.encoder, this.type)
+
+    return this.encoder
+  }
+}

package/src/types.ts

@@ -17,6 +17,7 @@ export enum MessageType {
   Auth = 2,
   QueryAwareness = 3,
   Stateless = 5,
+  CLOSE = 7,
 }
 
 export enum WebSocketStatus {