@hocuspocus/provider 2.0.0-alpha.1 → 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;

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.1",
+  "version": "2.0.0-beta.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,7 +28,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^2.0.0-alpha.1",
+    "@hocuspocus/common": "^2.0.0-beta.0",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.47",
     "ws": "^7.5.9"

package/src/HocuspocusProvider.ts

@@ -26,14 +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 {
    /**
@@ -135,6 +141,8 @@ export class HocuspocusProvider extends EventEmitter {
     forceSync: null,
   }
 
+  isConnected = true
+
   constructor(configuration: HocuspocusProviderConfiguration) {
     super()
     this.setConfiguration(configuration)
@@ -204,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 }
   }
 
@@ -327,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) })
     }
@@ -382,6 +396,7 @@ 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