@hocuspocus/provider 2.9.2-rc.0 → 2.11.0

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

@@ -121,7 +121,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     set synced(state: boolean);
     receiveStateless(payload: string): void;
     get isAuthenticationRequired(): boolean;
-    connect(): Promise<unknown>;
+    connect(): Promise<any>;
     disconnect(): void;
     onOpen(event: Event): Promise<void>;
     getToken(): Promise<string | null>;

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

@@ -102,7 +102,7 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     receivedOnStatusPayload?: onStatusParameters | undefined;
     onOpen(event: Event): Promise<void>;
     onStatus(data: onStatusParameters): Promise<void>;
-    attach(provider: HocuspocusProvider): void;
+    attach(provider: HocuspocusProvider): Promise<any> | undefined;
     detach(provider: HocuspocusProvider): void;
     setConfiguration(configuration?: Partial<HocuspocusProviderWebsocketConfiguration>): void;
     cancelWebsocketRetry?: () => void;

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

@@ -45,13 +45,13 @@ export declare class TiptapCollabProvider extends HocuspocusProvider {
     private getThreadIndex;
     getThread<Data, CommentData>(id: string): TCollabThread<Data, CommentData> | null;
     private getYThread;
-    createThread(data: TCollabThread): TCollabThread | null;
-    updateThread(id: TCollabThread['id'], data: Pick<TCollabThread, 'data'>): TCollabThread | null;
+    createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'comments'>): TCollabThread | null;
+    updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data' | 'resolvedAt'>>): TCollabThread | null;
     deleteThread(id: TCollabThread['id']): void;
     getThreadComments(threadId: TCollabThread['id']): TCollabComment[] | null;
     getThreadComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabComment | null;
-    addComment(threadId: TCollabThread['id'], data: TCollabComment): TCollabThread | null;
-    updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: TCollabComment): TCollabThread | null;
+    addComment(threadId: TCollabThread['id'], data: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>): TCollabThread | null;
+    updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>): TCollabThread | null;
     deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabThread | null;
     watchThreads(callback: () => void): void;
     unwatchThreads(callback: () => void): void;

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

@@ -88,6 +88,7 @@ export type TCollabThread<Data = any, CommentData = any> = {
     id: string;
     createdAt: number;
     updatedAt: number;
+    resolvedAt?: string;
     comments: TCollabComment<CommentData>[];
     data: Data;
 };

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

@@ -87,7 +87,7 @@ export declare class Document extends Doc {
     /**
      * Broadcast stateless message to all connections
      */
-    broadcastStateless(payload: string): void;
+    broadcastStateless(payload: string, filter?: (conn: Connection) => boolean): void;
     destroy(): void;
 }
 export default Document;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "2.9.2-rc.0",
+  "version": "2.11.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -29,10 +29,9 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^2.9.2-rc.0",
+    "@hocuspocus/common": "^2.11.0",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.87",
-    "uuid": "^9.0.0",
     "ws": "^8.14.2"
   },
   "peerDependencies": {

package/src/HocuspocusProvider.ts

@@ -367,7 +367,9 @@ export class HocuspocusProvider extends EventEmitter {
       this.subscribeToBroadcastChannel()
     }
 
-    return this.configuration.websocketProvider.connect()
+    this.configuration.websocketProvider.shouldConnect = true
+
+    return this.configuration.websocketProvider.attach(this)
   }
 
   disconnect() {

package/src/HocuspocusProviderWebsocket.ts

@@ -217,10 +217,11 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
   }
 
   attach(provider: HocuspocusProvider) {
+    let connectPromise: Promise<any> | undefined
     this.configuration.providerMap.set(provider.configuration.name, provider)
 
     if (this.status === WebSocketStatus.Disconnected && this.shouldConnect) {
-      this.connect()
+      connectPromise = this.connect()
     }
 
     if (this.receivedOnOpenPayload) {
@@ -230,6 +231,8 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     if (this.receivedOnStatusPayload) {
       provider.onStatus(this.receivedOnStatusPayload)
     }
+
+    return connectPromise
   }
 
   detach(provider: HocuspocusProvider) {

package/src/TiptapCollabProvider.ts

@@ -141,7 +141,7 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     return this.getYThreads().get(index)
   }
 
-  createThread(data: TCollabThread) {
+  createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'comments'>) {
     const thread = new Y.Map()
     thread.set('id', uuidv4())
     thread.set('createdAt', (new Date()).toISOString())
@@ -151,7 +151,7 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     return this.updateThread(String(thread.get('id')), data)
   }
 
-  updateThread(id: TCollabThread['id'], data: Pick<TCollabThread, 'data'>) {
+  updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data' | 'resolvedAt'>>) {
     const thread = this.getYThread(id)
 
     if (thread === null) {
@@ -159,7 +159,14 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     }
 
     thread.set('updatedAt', (new Date()).toISOString())
-    thread.set('data', data.data)
+
+    if (data.data) {
+      thread.set('data', data.data)
+    }
+
+    if (data.resolvedAt || data.resolvedAt === null) {
+      thread.set('resolvedAt', data.resolvedAt)
+    }
 
     return thread.toJSON() as TCollabThread
   }
@@ -194,7 +201,7 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     return this.getThread(threadId)?.comments.find(comment => comment.id === commentId) ?? null
   }
 
-  addComment(threadId: TCollabThread['id'], data: TCollabComment) {
+  addComment(threadId: TCollabThread['id'], data: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>) {
     const thread = this.getYThread(threadId)
 
     if (thread === null) return null
@@ -209,7 +216,7 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     return thread.toJSON() as TCollabThread
   }
 
-  updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: TCollabComment) {
+  updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>) {
     const thread = this.getYThread(threadId)
 
     if (thread === null) return null
@@ -226,8 +233,14 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     if (comment === null) return null
 
     comment.set('updatedAt', (new Date()).toISOString())
-    comment.set('data', data.data)
-    comment.set('content', data.content)
+
+    if (data.data) {
+      comment.set('data', data.data)
+    }
+
+    if (data.content) {
+      comment.set('content', data.content)
+    }
 
     return thread.toJSON() as TCollabThread
   }

package/src/types.ts

@@ -110,6 +110,7 @@ export type TCollabThread<Data = any, CommentData = any> = {
   id: string;
   createdAt: number;
   updatedAt: number;
+  resolvedAt?: string; // (new Date()).toISOString()
   comments: TCollabComment<CommentData>[];
   data: Data
 }