@hocuspocus/provider 2.9.0 → 2.9.2-rc.0

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

@@ -1,13 +1,17 @@
 import type { AbstractType, YArrayEvent } from 'yjs';
 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
 import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
-import type { THistoryVersion } from './types';
-export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>);
+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 interface AdditionalTiptapCollabProviderConfiguration {
     /**
      * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
      */
     appId?: string;
+    /**
+     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
+     */
+    baseUrl?: string;
     websocketProvider?: TiptapCollabProviderWebsocket;
 }
 export declare class TiptapCollabProvider extends HocuspocusProvider {
@@ -36,4 +40,19 @@ export declare class TiptapCollabProvider extends HocuspocusProvider {
     isAutoVersioning(): boolean;
     enableAutoVersioning(): 1;
     disableAutoVersioning(): 0;
+    private getYThreads;
+    getThreads<Data, CommentData>(): TCollabThread<Data, CommentData>[];
+    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;
+    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;
+    deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabThread | null;
+    watchThreads(callback: () => void): void;
+    unwatchThreads(callback: () => void): void;
 }

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

@@ -4,7 +4,11 @@ export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
     /**
      * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
      */
-    appId: string;
+    appId?: string;
+    /**
+     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
+     */
+    baseUrl?: string;
 }
 export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
     constructor(configuration: TiptapCollabProviderWebsocketConfiguration);

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

@@ -84,6 +84,20 @@ export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];
+export type TCollabThread<Data = any, CommentData = any> = {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    comments: TCollabComment<CommentData>[];
+    data: Data;
+};
+export type TCollabComment<Data = any> = {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    data: Data;
+    content: any;
+};
 export type THistoryVersion = {
     name?: string;
     version: number;

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { IncomingMessage } from 'http';
 import WebSocket, { AddressInfo } from 'ws';
-import { Server as HocuspocusServer } from './Server';
+import { Server as HocuspocusServer } from './Server.js';
 import { Debugger } from './Debugger.js';
 import { DirectConnection } from './DirectConnection.js';
 import Document from './Document.js';

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
 import { WebSocketServer } from 'ws';
-import { Hocuspocus } from './Hocuspocus';
+import { Hocuspocus } from './Hocuspocus.js';
 export declare class Server {
     httpServer: HTTPServer;
     webSocketServer: WebSocketServer;

package/dist/playground/frontend/vite.config.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("vite").UserConfigExport;
+declare const _default: import("vite").UserConfig;
 export default _default;

package/package.json

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

package/src/TiptapCollabProvider.ts

@@ -1,17 +1,22 @@
 import type { AbstractType, YArrayEvent } from 'yjs'
+import * as Y from 'yjs'
+import { uuidv4 } from 'lib0/random'
 import {
   HocuspocusProvider,
   HocuspocusProviderConfiguration,
 } from './HocuspocusProvider.js'
 
 import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js'
-import type { THistoryVersion } from './types'
+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, 'appId'>>|
+  Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>)
 
 export interface AdditionalTiptapCollabProviderConfiguration {
   /**
@@ -19,6 +24,11 @@ export interface AdditionalTiptapCollabProviderConfiguration {
    */
   appId?: string,
 
+  /**
+   * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
+   */
+  baseUrl?: string
+
   websocketProvider?: TiptapCollabProviderWebsocket
 }
 
@@ -27,7 +37,7 @@ export class TiptapCollabProvider extends HocuspocusProvider {
 
   constructor(configuration: TiptapCollabProviderConfiguration) {
     if (!configuration.websocketProvider) {
-      configuration.websocketProvider = new TiptapCollabProviderWebsocket({ appId: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>).appId })
+      configuration.websocketProvider = new TiptapCollabProviderWebsocket({ appId: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>).appId, baseUrl: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>).baseUrl })
     }
 
     if (!configuration.token) {
@@ -87,4 +97,168 @@ export class TiptapCollabProvider extends HocuspocusProvider {
     return this.configuration.document.getMap<number>(`${this.tiptapCollabConfigurationPrefix}config`).set('autoVersioning', 0)
   }
 
+  private getYThreads() {
+    return this.configuration.document.getArray<Y.Map<any>>(`${this.tiptapCollabConfigurationPrefix}threads`)
+  }
+
+  getThreads<Data, CommentData>(): TCollabThread<Data, CommentData>[] {
+    return this.getYThreads().toJSON() as TCollabThread<Data, CommentData>[]
+  }
+
+  private getThreadIndex(id: string): number | null {
+    let index = null
+
+    let i = 0
+    // eslint-disable-next-line no-restricted-syntax
+    for (const thread of this.getThreads()) {
+      if (thread.id === id) {
+        index = i
+        break
+      }
+      i += 1
+    }
+
+    return index
+  }
+
+  getThread<Data, CommentData>(id: string): TCollabThread<Data, CommentData> | null {
+    const index = this.getThreadIndex(id)
+
+    if (index === null) {
+      return null
+    }
+
+    return this.getYThreads().get(index).toJSON() as TCollabThread<Data, CommentData>
+  }
+
+  private getYThread(id: string) {
+    const index = this.getThreadIndex(id)
+
+    if (index === null) {
+      return null
+    }
+
+    return this.getYThreads().get(index)
+  }
+
+  createThread(data: TCollabThread) {
+    const thread = new Y.Map()
+    thread.set('id', uuidv4())
+    thread.set('createdAt', (new Date()).toISOString())
+    thread.set('comments', new Y.Array())
+
+    this.getYThreads().push([thread])
+    return this.updateThread(String(thread.get('id')), data)
+  }
+
+  updateThread(id: TCollabThread['id'], data: Pick<TCollabThread, 'data'>) {
+    const thread = this.getYThread(id)
+
+    if (thread === null) {
+      return null
+    }
+
+    thread.set('updatedAt', (new Date()).toISOString())
+    thread.set('data', data.data)
+
+    return thread.toJSON() as TCollabThread
+  }
+
+  deleteThread(id: TCollabThread['id']) {
+    const index = this.getThreadIndex(id)
+
+    if (index === null) {
+      return
+    }
+
+    this.getYThreads().delete(index, 1)
+  }
+
+  getThreadComments(threadId: TCollabThread['id']): TCollabComment[] | null {
+    const index = this.getThreadIndex(threadId)
+
+    if (index === null) {
+      return null
+    }
+
+    return this.getThread(threadId)?.comments ?? []
+  }
+
+  getThreadComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabComment | null {
+    const index = this.getThreadIndex(threadId)
+
+    if (index === null) {
+      return null
+    }
+
+    return this.getThread(threadId)?.comments.find(comment => comment.id === commentId) ?? null
+  }
+
+  addComment(threadId: TCollabThread['id'], data: TCollabComment) {
+    const thread = this.getYThread(threadId)
+
+    if (thread === null) return null
+
+    const commentMap = new Y.Map()
+    commentMap.set('id', uuidv4())
+    commentMap.set('createdAt', (new Date()).toISOString())
+    thread.get('comments').push([commentMap])
+
+    this.updateComment(threadId, String(commentMap.get('id')), data)
+
+    return thread.toJSON() as TCollabThread
+  }
+
+  updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: TCollabComment) {
+    const thread = this.getYThread(threadId)
+
+    if (thread === null) return null
+
+    let comment = null
+    // eslint-disable-next-line no-restricted-syntax
+    for (const c of thread.get('comments')) {
+      if (c.get('id') === commentId) {
+        comment = c
+        break
+      }
+    }
+
+    if (comment === null) return null
+
+    comment.set('updatedAt', (new Date()).toISOString())
+    comment.set('data', data.data)
+    comment.set('content', data.content)
+
+    return thread.toJSON() as TCollabThread
+  }
+
+  deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']) {
+    const thread = this.getYThread(threadId)
+
+    if (thread === null) return null
+
+    let commentIndex = 0
+    // eslint-disable-next-line no-restricted-syntax
+    for (const c of thread.get('comments')) {
+      if (c.get('id') === commentId) {
+        break
+      }
+      commentIndex += 1
+    }
+
+    if (commentIndex >= 0) {
+      thread.get('comments').delete(commentIndex)
+    }
+
+    return thread.toJSON() as TCollabThread
+  }
+
+  watchThreads(callback: () => void) {
+    this.getYThreads().observeDeep(callback)
+  }
+
+  unwatchThreads(callback: () => void) {
+    this.getYThreads().unobserveDeep(callback)
+  }
+
 }

package/src/TiptapCollabProviderWebsocket.ts

@@ -11,11 +11,16 @@ export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
   /**
    * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
    */
-  appId: string,
+  appId?: string,
+
+  /**
+   * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
+   */
+  baseUrl?: string
 }
 
 export class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
   constructor(configuration: TiptapCollabProviderWebsocketConfiguration) {
-    super({ ...configuration as HocuspocusProviderWebsocketConfiguration, url: `wss://${configuration.appId}.collab.tiptap.cloud` })
+    super({ ...configuration as HocuspocusProviderWebsocketConfiguration, url: configuration.baseUrl ?? `wss://${configuration.appId}.collab.tiptap.cloud` })
   }
 }

package/src/types.ts

@@ -106,6 +106,22 @@ export type StatesArray = { clientId: number, [key: string | number]: any }[]
 
 // hocuspocus-pro types
 
+export type TCollabThread<Data = any, CommentData = any> = {
+  id: string;
+  createdAt: number;
+  updatedAt: number;
+  comments: TCollabComment<CommentData>[];
+  data: Data
+}
+
+export type TCollabComment<Data = any> = {
+  id: string;
+  createdAt: number;
+  updatedAt: number;
+  data: Data
+  content: any
+}
+
 export type THistoryVersion = {
   name?: string;
   version: number;