@hocuspocus/provider 2.0.0-alpha.1 → 2.0.0

package/dist/packages/extension-monitor/src/Dashboard.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncomingMessage, ServerResponse } from 'http';
 import { Socket } from 'net';
 import WebSocket, { WebSocketServer } from 'ws';

package/dist/packages/extension-redis/src/Redis.d.ts

@@ -1,7 +1,7 @@
 import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
 import Redlock from 'redlock';
 import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, onListenPayload, beforeBroadcastStatelessPayload } from '@hocuspocus/server';
-export declare type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
+export type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
 export interface Configuration {
     /**
      * Redis port

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/HocuspocusCloudProvider.d.ts

@@ -1,6 +1,6 @@
 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
 import { HocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket';
-export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> & AdditionalHocuspocusCloudProviderConfiguration;
+export type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> & AdditionalHocuspocusCloudProviderConfiguration;
 export interface AdditionalHocuspocusCloudProviderConfiguration {
     /**
      * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/

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 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/packages/provider/src/HocuspocusProviderWebsocket.d.ts

@@ -4,7 +4,7 @@ import { Event } from 'ws';
 import EventEmitter from './EventEmitter';
 import { onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, WebSocketStatus } from './types';
 import { HocuspocusProvider, onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
-export declare type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
+export type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
 export interface CompleteHocuspocusProviderWebsocketConfiguration {
     /**
      * URL of your @hocuspocus/server instance

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

@@ -0,0 +1,11 @@
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
+export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & AdditionalTiptapCollabProviderConfiguration;
+export interface AdditionalTiptapCollabProviderConfiguration {
+    /**
+     * A Hocuspocus Cloud App ID, get one here: https://collab.tiptap.dev
+     */
+    appId: string;
+}
+export declare class TiptapCollabProvider extends HocuspocusProvider {
+    constructor(configuration: TiptapCollabProviderConfiguration);
+}

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

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

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

@@ -43,42 +43,42 @@ export interface OutgoingMessageArguments {
 export interface Constructable<T> {
     new (...args: any): T;
 }
-export declare type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
-export declare type onAuthenticationFailedParameters = {
+export type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
+export type onAuthenticationFailedParameters = {
     reason: string;
 };
-export declare type onOpenParameters = {
+export type onOpenParameters = {
     event: Event;
 };
-export declare type onMessageParameters = {
+export type onMessageParameters = {
     event: MessageEvent;
     message: IncomingMessage;
 };
-export declare type onOutgoingMessageParameters = {
+export type onOutgoingMessageParameters = {
     message: OutgoingMessage;
 };
-export declare type onStatusParameters = {
+export type onStatusParameters = {
     status: WebSocketStatus;
 };
-export declare type onSyncedParameters = {
+export type onSyncedParameters = {
     state: boolean;
 };
-export declare type onDisconnectParameters = {
+export type onDisconnectParameters = {
     event: CloseEvent;
 };
-export declare type onCloseParameters = {
+export type onCloseParameters = {
     event: CloseEvent;
 };
-export declare type onAwarenessUpdateParameters = {
+export type onAwarenessUpdateParameters = {
     states: StatesArray;
 };
-export declare type onAwarenessChangeParameters = {
+export type onAwarenessChangeParameters = {
     states: StatesArray;
 };
-export declare type onStatelessParameters = {
+export type onStatelessParameters = {
     payload: string;
 };
-export declare type StatesArray = {
+export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncomingMessage as HTTPIncomingMessage } from 'http';
 import AsyncLock from 'async-lock';
 import WebSocket from 'ws';
@@ -23,7 +24,7 @@ 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;
+    boundClose: (event?: CloseEvent) => void;
     boundHandleMessage: (data: Uint8Array) => void;
     boundHandlePong: () => void;
     handlePong(): void;

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncomingMessage, Server as HTTPServer } from 'http';
 import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
 import { Configuration, HookName, HookPayload, onListenPayload } from './types';

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

@@ -1,4 +1,6 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
 import { URLSearchParams } from 'url';
 import { Awareness } from 'y-protocols/awareness';
@@ -47,8 +49,8 @@ export interface Extension {
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
-export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onStatelessPayload | beforeHandleMessagePayload | beforeBroadcastStatelessPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
+export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onStatelessPayload | beforeHandleMessagePayload | beforeBroadcastStatelessPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
 export interface Configuration extends Extension {
     /**
      * A name for the instance, used for logging.
@@ -208,7 +210,7 @@ export interface onAwarenessUpdatePayload {
     awareness: Awareness;
     states: StatesArray;
 }
-export declare type StatesArray = {
+export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];

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

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

package/dist/tests/utils/newHocuspocus.d.ts

@@ -1,2 +1,2 @@
 import { Hocuspocus, Configuration } from '@hocuspocus/server';
-export declare const newHocuspocus: (options?: Partial<Configuration> | undefined) => Promise<Hocuspocus>;
+export declare const newHocuspocus: (options?: Partial<Configuration>) => Promise<Hocuspocus>;

package/package.json

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

package/src/TiptapCollabProvider.ts

@@ -0,0 +1,33 @@
+import {
+  HocuspocusProvider,
+  HocuspocusProviderConfiguration,
+} from './HocuspocusProvider'
+import {
+  HocuspocusProviderWebsocket,
+} from './HocuspocusProviderWebsocket'
+
+export type TiptapCollabProviderConfiguration =
+  Required<Pick<HocuspocusProviderConfiguration, 'name'>> &
+  Partial<HocuspocusProviderConfiguration> &
+  AdditionalTiptapCollabProviderConfiguration
+
+export interface AdditionalTiptapCollabProviderConfiguration {
+  /**
+   * A Hocuspocus Cloud App ID, get one here: https://collab.tiptap.dev
+   */
+  appId: string,
+}
+
+export class TiptapCollabProvider extends HocuspocusProvider {
+  constructor(configuration: TiptapCollabProviderConfiguration) {
+    if (!configuration.websocketProvider) {
+      configuration.websocketProvider = new HocuspocusProviderWebsocket({ url: `wss://${configuration.appId}.collab.tiptap.cloud` })
+    }
+
+    if (!configuration.token) {
+      configuration.token = 'notoken'
+    }
+
+    super(configuration as HocuspocusProviderConfiguration)
+  }
+}

package/src/index.ts

@@ -1,4 +1,4 @@
 export * from './HocuspocusProvider'
-export * from './HocuspocusCloudProvider'
+export * from './TiptapCollabProvider'
 export * from './HocuspocusProviderWebsocket'
 export * from './types'