@hocuspocus/provider 2.12.0-rc.0 → 2.12.2-rc.0

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

@@ -1,4 +1,5 @@
-import { type MessageEvent, Event } from 'ws';
+import type { MessageEvent } from 'ws';
+import { Event } from 'ws';
 import EventEmitter from './EventEmitter.js';
 import { HocuspocusProvider } from './HocuspocusProvider.js';
 import { WebSocketStatus, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters } from './types.js';

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

@@ -1,8 +1,9 @@
 import type { AbstractType, YArrayEvent } from 'yjs';
+import * as Y from 'yjs';
 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
 import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
 import type { TCollabComment, TCollabThread, THistoryVersion } from './types.js';
-export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>);
+export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>) & Pick<AdditionalTiptapCollabProviderConfiguration, 'user'>;
 export interface AdditionalTiptapCollabProviderConfiguration {
     /**
      * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
@@ -13,9 +14,11 @@ export interface AdditionalTiptapCollabProviderConfiguration {
      */
     baseUrl?: string;
     websocketProvider?: TiptapCollabProviderWebsocket;
+    user?: string;
 }
 export declare class TiptapCollabProvider extends HocuspocusProvider {
     tiptapCollabConfigurationPrefix: string;
+    userData?: Y.PermanentUserData;
     constructor(configuration: TiptapCollabProviderConfiguration);
     /**
      * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.

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

@@ -38,6 +38,7 @@ export interface Extension {
     onConnect?(data: onConnectPayload): Promise<any>;
     connected?(data: connectedPayload): Promise<any>;
     onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
+    onCreateDocument?(data: onCreateDocumentPayload): Promise<any>;
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     afterLoadDocument?(data: afterLoadDocumentPayload): Promise<any>;
     beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
@@ -52,7 +53,7 @@ export interface Extension {
     afterUnloadDocument?(data: afterUnloadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'afterUnloadDocument' | 'onDestroy';
+export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'afterUnloadDocument' | 'onDestroy';
 export type HookPayloadByName = {
     onConfigure: onConfigurePayload;
     onListen: onListenPayload;
@@ -60,6 +61,7 @@ export type HookPayloadByName = {
     onConnect: onConnectPayload;
     connected: connectedPayload;
     onAuthenticate: onAuthenticatePayload;
+    onCreateDocument: onCreateDocumentPayload;
     onLoadDocument: onLoadDocumentPayload;
     afterLoadDocument: afterLoadDocumentPayload;
     beforeHandleMessage: beforeHandleMessagePayload;
@@ -142,10 +144,20 @@ export interface onAuthenticatePayload {
     instance: Hocuspocus;
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
+    request: IncomingMessage;
     socketId: string;
     token: string;
     connection: ConnectionConfiguration;
 }
+export interface onCreateDocumentPayload {
+    context: any;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
 export interface onConnectPayload {
     context: any;
     documentName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "2.12.0-rc.0",
+  "version": "2.12.2-rc.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^2.12.0-rc.0",
+    "@hocuspocus/common": "^2.12.2-rc.0",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.87",
     "ws": "^8.14.2"

package/src/HocuspocusProviderWebsocket.ts

@@ -4,7 +4,8 @@ import {
 import { retry } from '@lifeomic/attempt'
 import * as time from 'lib0/time'
 import * as url from 'lib0/url'
-import { type MessageEvent, Event } from 'ws'
+import type { MessageEvent } from 'ws'
+import { Event } from 'ws'
 import EventEmitter from './EventEmitter.js'
 import { HocuspocusProvider } from './HocuspocusProvider.js'
 import {
@@ -348,7 +349,7 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
       this.identifier += 1
 
       // Init the WebSocket connection
-      const ws = new this.configuration.WebSocketPolyfill(this.url, { followRedirects: true })
+      const ws = new this.configuration.WebSocketPolyfill(this.url)
       ws.binaryType = 'arraybuffer'
       ws.identifier = this.identifier
 

package/src/TiptapCollabProvider.ts

@@ -16,7 +16,8 @@ export type TiptapCollabProviderConfiguration =
   Partial<HocuspocusProviderConfiguration> &
   (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> |
   Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>|
-  Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>)
+  Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>) &
+  Pick<AdditionalTiptapCollabProviderConfiguration, 'user'>
 
 export interface AdditionalTiptapCollabProviderConfiguration {
   /**
@@ -30,11 +31,15 @@ export interface AdditionalTiptapCollabProviderConfiguration {
   baseUrl?: string
 
   websocketProvider?: TiptapCollabProviderWebsocket
+
+  user?: string
 }
 
 export class TiptapCollabProvider extends HocuspocusProvider {
   tiptapCollabConfigurationPrefix = '__tiptapcollab__'
 
+  userData?: Y.PermanentUserData
+
   constructor(configuration: TiptapCollabProviderConfiguration) {
     if (!configuration.websocketProvider) {
       configuration.websocketProvider = new TiptapCollabProviderWebsocket({ appId: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>).appId, baseUrl: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>).baseUrl })
@@ -45,6 +50,11 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     }
 
     super(configuration as HocuspocusProviderConfiguration)
+
+    if (configuration.user) {
+      this.userData = new Y.PermanentUserData(this.document, this.document.getMap('__tiptapcollab__users'))
+      this.userData.setUserMapping(this.document, this.document.clientID, configuration.user)
+    }
   }
 
   /**