@hocuspocus/provider 2.6.1 → 2.7.1

package/dist/packages/extension-database/src/Database.d.ts

@@ -8,7 +8,7 @@ export interface DatabaseConfiguration {
     /**
      * Pass a function to store updates in your database.
      */
-    store: (data: storePayload) => void;
+    store: (data: storePayload) => Promise<void>;
 }
 export declare class Database implements Extension {
     /**

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

@@ -91,7 +91,6 @@ export declare class HocuspocusProvider extends EventEmitter {
     boundBroadcastChannelSubscriber: (data: ArrayBuffer) => void;
     boundPageUnload: () => void;
     boundOnOpen: (event: Event) => Promise<void>;
-    boundOnMessage: (event: MessageEvent) => void;
     boundOnClose: (event: CloseEvent) => void;
     boundOnStatus: ({ status }: onStatusParameters) => void;
     forwardConnect: (e: any) => this;

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

@@ -77,6 +77,10 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
      * Don’t output any warnings.
      */
     quiet: boolean;
+    /**
+     * Map of attached providers keyed by documentName.
+     */
+    providerMap: Map<string, HocuspocusProvider>;
 }
 export declare class HocuspocusProviderWebsocket extends EventEmitter {
     private messageQueue;

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

@@ -6,6 +6,7 @@ export declare class IncomingMessage {
     encoder: Encoder;
     decoder: Decoder;
     constructor(data: any);
+    peekVarString(): string;
     readVarUint(): MessageType;
     readVarString(): string;
     readVarUint8Array(): Uint8Array;

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

@@ -10,5 +10,5 @@ export declare class DirectConnection implements DirectConnectionInterface {
      */
     constructor(document: Document, instance: Hocuspocus, context?: any);
     transact(transaction: (document: Document) => void, transactionOrigin?: any): Promise<void>;
-    disconnect(): void;
+    disconnect(): Promise<void>;
 }

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

@@ -19,6 +19,7 @@ export declare class Document extends Doc {
     mux: mutex;
     logger: Debugger;
     isLoading: boolean;
+    isDestroyed: boolean;
     /**
      * Constructor.
      */
@@ -87,5 +88,6 @@ export declare class Document extends Doc {
      * Broadcast stateless message to all connections
      */
     broadcastStateless(payload: string): void;
+    destroy(): void;
 }
 export default Document;

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

@@ -82,7 +82,7 @@ export declare class Hocuspocus {
      * Create a new document by the given request
      */
     createDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
-    storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload): void;
+    storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload): Promise<void>;
     /**
      * Run the given hook on all configured extensions.
      * Runs the given callback after each hook.

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

@@ -131,6 +131,7 @@ export interface onStatelessPayload {
     payload: string;
 }
 export interface onAuthenticatePayload {
+    context: any;
     documentName: string;
     instance: Hocuspocus;
     requestHeaders: IncomingHttpHeaders;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "2.6.1",
+  "version": "2.7.1",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -29,10 +29,10 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^2.6.1",
+    "@hocuspocus/common": "^2.7.1",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.47",
-    "ws": "^7.5.9"
+    "ws": "^8.14.2"
   },
   "peerDependencies": {
     "y-protocols": "^1.0.5",

package/src/HocuspocusProvider.ts

@@ -192,8 +192,6 @@ export class HocuspocusProvider extends EventEmitter {
     this.configuration.websocketProvider.on('open', this.boundOnOpen)
     this.configuration.websocketProvider.on('open', this.forwardOpen)
 
-    this.configuration.websocketProvider.on('message', this.boundOnMessage)
-
     this.configuration.websocketProvider.on('close', this.boundOnClose)
     this.configuration.websocketProvider.on('close', this.configuration.onClose)
     this.configuration.websocketProvider.on('close', this.forwardClose)
@@ -234,8 +232,6 @@ export class HocuspocusProvider extends EventEmitter {
 
   boundOnOpen = this.onOpen.bind(this)
 
-  boundOnMessage = this.onMessage.bind(this)
-
   boundOnClose = this.onClose.bind(this)
 
   boundOnStatus = this.onStatus.bind(this)
@@ -387,9 +383,17 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.emit('open', { event })
 
+    let token: string | null
+    try {
+      token = await this.getToken()
+    } catch (error) {
+      this.permissionDeniedHandler(`Failed to get token: ${error}`)
+      return
+    }
+
     if (this.isAuthenticationRequired) {
       this.send(AuthenticationMessage, {
-        token: await this.getToken(),
+        token,
         documentName: this.configuration.name,
       })
     }
@@ -439,10 +443,6 @@ export class HocuspocusProvider extends EventEmitter {
 
     const documentName = message.readVarString()
 
-    if (documentName !== this.configuration.name) {
-      return // message is meant for another provider
-    }
-
     message.writeVarString(documentName)
 
     this.emit('message', { event, message: new IncomingMessage(event.data) })
@@ -486,7 +486,6 @@ export class HocuspocusProvider extends EventEmitter {
     this.configuration.websocketProvider.off('connect', this.forwardConnect)
     this.configuration.websocketProvider.off('open', this.boundOnOpen)
     this.configuration.websocketProvider.off('open', this.forwardOpen)
-    this.configuration.websocketProvider.off('message', this.boundOnMessage)
     this.configuration.websocketProvider.off('close', this.boundOnClose)
     this.configuration.websocketProvider.off('close', this.configuration.onClose)
     this.configuration.websocketProvider.off('close', this.forwardClose)

package/src/HocuspocusProviderWebsocket.ts

@@ -14,6 +14,7 @@ import {
   onAwarenessChangeParameters, onAwarenessUpdateParameters,
   onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters,
 } from './types.js'
+import { IncomingMessage } from './IncomingMessage.js'
 
 export type HocusPocusWebSocket = WebSocket & { identifier: string };
 
@@ -91,6 +92,11 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
    * Don’t output any warnings.
    */
   quiet: boolean,
+
+  /**
+   * Map of attached providers keyed by documentName.
+   */
+  providerMap: Map<string, HocuspocusProvider>,
 }
 
 export class HocuspocusProviderWebsocket extends EventEmitter {
@@ -134,6 +140,7 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     onAwarenessUpdate: () => null,
     onAwarenessChange: () => null,
     quiet: false,
+    providerMap: new Map(),
   }
 
   subscribedToBroadcastChannel = false
@@ -215,6 +222,8 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
   }
 
   attach(provider: HocuspocusProvider) {
+    this.configuration.providerMap.set(provider.configuration.name, provider)
+
     if (this.status === WebSocketStatus.Disconnected && this.shouldConnect) {
       this.connect()
     }
@@ -229,7 +238,7 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
   }
 
   detach(provider: HocuspocusProvider) {
-    // tell the server to remove the listener
+    this.configuration.providerMap.delete(provider.configuration.name)
   }
 
   public setConfiguration(
@@ -368,6 +377,11 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     this.resolveConnectionAttempt()
 
     this.lastMessageReceived = time.getUnixTime()
+
+    const message = new IncomingMessage(event.data)
+    const documentName = message.peekVarString()
+
+    this.configuration.providerMap.get(documentName)?.onMessage(event)
   }
 
   resolveConnectionAttempt() {

package/src/IncomingMessage.ts

@@ -1,5 +1,6 @@
 import {
   createDecoder,
+  peekVarString,
   readVarUint,
   readVarUint8Array,
   readVarString,
@@ -29,6 +30,10 @@ export class IncomingMessage {
     this.decoder = createDecoder(new Uint8Array(this.data))
   }
 
+  peekVarString(): string {
+    return peekVarString(this.decoder)
+  }
+
   readVarUint(): MessageType {
     return readVarUint(this.decoder)
   }

package/src/OutgoingMessages/QueryAwarenessMessage.ts

@@ -9,9 +9,6 @@ export class QueryAwarenessMessage extends OutgoingMessage {
 
   get(args: Partial<OutgoingMessageArguments>) {
 
-    console.log('queryAwareness: writing string docName', args.documentName)
-    console.log(this.encoder.cpos)
-
     encoding.writeVarString(this.encoder, args.documentName!)
     encoding.writeVarUint(this.encoder, this.type)