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

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

@@ -87,6 +87,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "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-alpha.1",
     "@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

@@ -28,6 +28,7 @@ import {
 } from './types'
 import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket'
 import { StatelessMessage } from './OutgoingMessages/StatelessMessage'
+import { CloseMessage } from './OutgoingMessages/CloseMessage'
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.'
 
 export type HocuspocusProviderConfiguration =
@@ -281,6 +282,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 +300,6 @@ export class HocuspocusProvider extends EventEmitter {
         token: await this.getToken(),
         documentName: this.configuration.name,
       })
-      return
     }
 
     this.startSync()
@@ -376,6 +381,8 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.removeAllListeners()
 
+    this.send(CloseMessage, { documentName: this.configuration.name })
+
     if (typeof window === 'undefined') {
       return
     }

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 {