@hocuspocus/provider 3.0.0-rc.0 → 3.0.4-rc.0

package/src/MessageReceiver.ts

@@ -2,6 +2,7 @@ import { readAuthMessage } from '@hocuspocus/common'
 import { readVarInt, readVarString } from 'lib0/decoding'
 import * as awarenessProtocol from 'y-protocols/awareness'
 import { messageYjsSyncStep2, readSyncMessage } from 'y-protocols/sync'
+import type { CloseEvent } from 'ws'
 import type { HocuspocusProvider } from './HocuspocusProvider.js'
 import type { IncomingMessage } from './IncomingMessage.js'
 import { OutgoingMessage } from './OutgoingMessage.js'
@@ -11,18 +12,10 @@ export class MessageReceiver {
 
   message: IncomingMessage
 
-  broadcasted = false
-
   constructor(message: IncomingMessage) {
     this.message = message
   }
 
-  public setBroadcasted(value: boolean) {
-    this.broadcasted = value
-
-    return this
-  }
-
   public apply(provider: HocuspocusProvider, emitSynced: boolean) {
     const { message } = this
     const type = message.readVarUint()
@@ -53,21 +46,29 @@ export class MessageReceiver {
       case MessageType.SyncStatus:
         this.applySyncStatusMessage(provider, readVarInt(message.decoder) === 1)
         break
+
+      case MessageType.CLOSE:
+        // eslint-disable-next-line no-case-declarations
+        const event: CloseEvent = {
+          code: 1000,
+          reason: readVarString(message.decoder),
+          // @ts-ignore
+          target: provider.configuration.websocketProvider.webSocket!,
+          type: 'close',
+        }
+        provider.onClose()
+        provider.configuration.onClose({ event })
+        provider.forwardClose(event)
+      break
+
       default:
         throw new Error(`Can’t apply message of unknown type: ${type}`)
     }
 
     // Reply
     if (message.length() > emptyMessageLength + 1) { // length of documentName (considered in emptyMessageLength plus length of yjs sync type, set in applySyncMessage)
-      if (this.broadcasted) {
-        // TODO: Some weird TypeScript error
-        // @ts-ignore
-        provider.broadcast(OutgoingMessage, { encoder: message.encoder })
-      } else {
-        // TODO: Some weird TypeScript error
-        // @ts-ignore
-        provider.send(OutgoingMessage, { encoder: message.encoder })
-      }
+      // @ts-ignore
+      provider.send(OutgoingMessage, { encoder: message.encoder })
     }
   }
 

package/src/index.ts

@@ -1,5 +1,3 @@
 export * from './HocuspocusProvider.js'
-export * from './TiptapCollabProvider.js'
-export * from './TiptapCollabProviderWebsocket.js'
 export * from './HocuspocusProviderWebsocket.js'
 export * from './types.js'

package/src/types.ts

@@ -110,15 +110,18 @@ export type TCollabThread<Data = any, CommentData = any> = {
   id: string;
   createdAt: number;
   updatedAt: number;
+  deletedAt: number | null;
   resolvedAt?: string; // (new Date()).toISOString()
   comments: TCollabComment<CommentData>[];
+  deletedComments: TCollabComment<CommentData>[];
   data: Data
 }
 
 export type TCollabComment<Data = any> = {
   id: string;
-  createdAt: number;
-  updatedAt: number;
+  createdAt: string;
+  updatedAt: string;
+  deletedAt?: string;
   data: Data
   content: any
 }
@@ -183,3 +186,46 @@ export type THistoryDocumentRevertedEvent = {
   event: 'document.reverted';
   version: number;
 };
+
+export type DeleteCommentOptions = {
+  /**
+   * If `true`, the thread will also be deleted if the deleted comment was the first comment in the thread.
+   */
+  deleteThread?: boolean
+
+  /**
+   * If `true`, will remove the content of the deleted comment
+   */
+  deleteContent?: boolean
+}
+
+export type DeleteThreadOptions = {
+  /**
+   * If `true`, will remove the comments on the thread,
+   * otherwise will only mark the thread as deleted
+   * and keep the comments
+   * @default false
+   */
+  deleteComments?: boolean
+
+  /**
+   * If `true`, will forcefully remove the thread and all comments,
+   * otherwise will only mark the thread as deleted
+   * and keep the comments
+   * @default false
+   */
+  force?: boolean,
+}
+
+/**
+ * The type of thread
+ */
+export type ThreadType = 'archived' | 'unarchived'
+
+export type GetThreadsOptions = {
+  /**
+   * The types of threads to get
+   * @default ['unarchived']
+   */
+  types?: Array<ThreadType>
+}

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

@@ -1,64 +0,0 @@
-import type { AbstractType, YArrayEvent } from 'yjs';
-import * as Y from 'yjs';
-import type { HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
-import { HocuspocusProvider } 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'>>) & Pick<AdditionalTiptapCollabProviderConfiguration, 'user'>;
-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;
-    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.
-     */
-    createVersion(name?: string): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    revertToVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     *
-     * The server will reply with a stateless message (THistoryVersionPreviewEvent)
-     */
-    previewVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    getVersions(): THistoryVersion[];
-    watchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['observe']>[0]): void;
-    unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['unobserve']>[0]): void;
-    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: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'comments'>): TCollabThread;
-    updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data'> & {
-        resolvedAt: TCollabThread['resolvedAt'] | null;
-    }>): TCollabThread;
-    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: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>): TCollabThread;
-    updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>): TCollabThread;
-    deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabThread | null | undefined;
-    watchThreads(callback: () => void): void;
-    unwatchThreads(callback: () => void): void;
-}

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

@@ -1,20 +0,0 @@
-import type { CompleteHocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket.js';
-import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket.js';
-export type TiptapCollabProviderWebsocketConfiguration = Partial<CompleteHocuspocusProviderWebsocketConfiguration> & AdditionalTiptapCollabProviderWebsocketConfiguration;
-export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
-    /**
-     * 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;
-    /**
-     * Only fill this if you are using Tiptap Collab HA.
-     */
-    shardKey?: string;
-}
-export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
-    constructor(configuration: TiptapCollabProviderWebsocketConfiguration);
-}

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

@@ -1,14 +0,0 @@
-export declare class Debugger {
-    logs: any[];
-    listen: boolean;
-    output: boolean;
-    enable(): void;
-    disable(): void;
-    verbose(): void;
-    quiet(): void;
-    log(message: any): this;
-    flush(): this;
-    get(): {
-        logs: any[];
-    };
-}

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

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

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

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

package/src/TiptapCollabProvider.ts

@@ -1,321 +0,0 @@
-import type { AbstractType, YArrayEvent } from 'yjs'
-import * as Y from 'yjs'
-import { uuidv4 } from 'lib0/random'
-import type {
-  HocuspocusProviderConfiguration} from './HocuspocusProvider.js'
-import {
-  HocuspocusProvider,
-} 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'>>) &
-  Pick<AdditionalTiptapCollabProviderConfiguration, 'user'>
-
-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
-
-  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 })
-    }
-
-    if (!configuration.token) {
-      configuration.token = 'notoken' // need to send a token anyway (which will be ignored)
-    }
-
-    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)
-    }
-  }
-
-  /**
-   * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-   */
-  createVersion(name?: string) {
-    return this.sendStateless(JSON.stringify({ action: 'version.create', name }))
-  }
-
-  /**
-   * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-   */
-  revertToVersion(targetVersion: number) {
-    return this.sendStateless(JSON.stringify({ action: 'document.revert', version: targetVersion }))
-  }
-
-  /**
-   * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-   *
-   * The server will reply with a stateless message (THistoryVersionPreviewEvent)
-   */
-  previewVersion(targetVersion: number) {
-    return this.sendStateless(JSON.stringify({ action: 'version.preview', version: targetVersion }))
-  }
-
-  /**
-   * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-   */
-  getVersions(): THistoryVersion[] {
-    return this.configuration.document.getArray<THistoryVersion>(`${this.tiptapCollabConfigurationPrefix}versions`).toArray()
-  }
-
-  watchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['observe']>[0]) {
-    return this.configuration.document.getArray<THistoryVersion>('__tiptapcollab__versions').observe(callback)
-  }
-
-  unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['unobserve']>[0]) {
-    return this.configuration.document.getArray<THistoryVersion>('__tiptapcollab__versions').unobserve(callback)
-  }
-
-  isAutoVersioning(): boolean {
-    return !!this.configuration.document.getMap<number>(`${this.tiptapCollabConfigurationPrefix}config`).get('autoVersioning')
-  }
-
-  enableAutoVersioning() {
-    return this.configuration.document.getMap<number>(`${this.tiptapCollabConfigurationPrefix}config`).set('autoVersioning', 1)
-  }
-
-  disableAutoVersioning() {
-    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: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'comments'>) {
-    let createdThread: TCollabThread = {} as TCollabThread
-
-    this.document.transact(() => {
-      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])
-      createdThread = this.updateThread(String(thread.get('id')), data)
-    })
-
-    return createdThread
-  }
-
-  updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data'> & {
-    resolvedAt: TCollabThread['resolvedAt'] | null
-  }>) {
-    let updatedThread: TCollabThread = {} as TCollabThread
-
-    this.document.transact(() => {
-      const thread = this.getYThread(id)
-
-      if (thread === null) {
-        return null
-      }
-
-      thread.set('updatedAt', (new Date()).toISOString())
-
-      if (data.data) {
-        thread.set('data', data.data)
-      }
-
-      if (data.resolvedAt || data.resolvedAt === null) {
-        thread.set('resolvedAt', data.resolvedAt)
-      }
-
-      updatedThread = thread.toJSON() as TCollabThread
-    })
-
-    return updatedThread
-  }
-
-  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: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>) {
-    let updatedThread: TCollabThread = {} as TCollabThread
-
-    this.document.transact(() => {
-      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)
-
-      updatedThread = thread.toJSON() as TCollabThread
-    })
-
-    return updatedThread
-  }
-
-  updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>) {
-    let updatedThread: TCollabThread = {} as TCollabThread
-
-    this.document.transact(() => {
-      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())
-
-      if (data.data) {
-        comment.set('data', data.data)
-      }
-
-      if (data.content) {
-        comment.set('content', data.content)
-      }
-
-      updatedThread = thread.toJSON() as TCollabThread
-    })
-
-    return updatedThread
-  }
-
-  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 the first comment of a thread is deleted we also
-    // delete the thread itself as the source comment is gone
-    if (commentIndex === 0) {
-      this.deleteThread(threadId)
-      return
-    }
-
-    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

@@ -1,39 +0,0 @@
-import type {
-  CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocketConfiguration} from './HocuspocusProviderWebsocket.js'
-import {
-  HocuspocusProviderWebsocket,
-} from './HocuspocusProviderWebsocket.js'
-
-export type TiptapCollabProviderWebsocketConfiguration =
-  Partial<CompleteHocuspocusProviderWebsocketConfiguration> &
-  AdditionalTiptapCollabProviderWebsocketConfiguration
-
-export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
-  /**
-   * 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
-
-  /**
-   * Only fill this if you are using Tiptap Collab HA.
-   */
-  shardKey?: string
-}
-
-export class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
-  constructor(configuration: TiptapCollabProviderWebsocketConfiguration) {
-    let url = configuration.baseUrl ?? `wss://${configuration.appId}.collab.tiptap.cloud`
-
-    if (configuration.shardKey) {
-      url += url.includes('?') ? '&' : '?'
-      url += `shard=${configuration.shardKey}`
-    }
-
-    super({ ...configuration as HocuspocusProviderWebsocketConfiguration, url })
-  }
-}