@hocuspocus/common 2.14.0 → 2.15.0

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

@@ -2,7 +2,7 @@ import type { AbstractType, YArrayEvent } from 'yjs';
 import * as Y from 'yjs';
 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
 import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
-import type { DeleteCommentOptions, TCollabComment, TCollabThread, THistoryVersion } from './types.js';
+import { type DeleteCommentOptions, type DeleteThreadOptions, type GetThreadsOptions, type TCollabComment, type TCollabThread, type 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'> & {
     /**
      * Pass `true` if you want to delete a thread when the first comment is deleted.
@@ -55,9 +55,10 @@ export declare class TiptapCollabProvider extends HocuspocusProvider {
     private getYThreads;
     /**
      * Finds all threads in the document and returns them as JSON objects
+     * @options Options to control the output of the threads (e.g. include deleted threads)
      * @returns An array of threads as JSON objects
      */
-    getThreads<Data, CommentData>(): TCollabThread<Data, CommentData>[];
+    getThreads<Data, CommentData>(options?: GetThreadsOptions): TCollabThread<Data, CommentData>[];
     /**
      * Find the index of a thread by its id
      * @param id The thread id
@@ -81,7 +82,7 @@ export declare class TiptapCollabProvider extends HocuspocusProvider {
      * @param data The thread data
      * @returns The created thread
      */
-    createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'comments' | 'deletedComments'>): TCollabThread;
+    createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'deletedAt' | 'comments' | 'deletedComments'>): TCollabThread;
     /**
      * Update a specific thread
      * @param id The thread id
@@ -92,11 +93,21 @@ export declare class TiptapCollabProvider extends HocuspocusProvider {
         resolvedAt: TCollabThread['resolvedAt'] | null;
     }>): TCollabThread;
     /**
-     * Delete a specific thread and all its comments
+     * Handle the deletion of a thread. By default, the thread and it's comments are not deleted, but marked as deleted
+     * via the `deletedAt` property. Forceful deletion can be enabled by setting the `force` option to `true`.
+     *
+     * If you only want to delete the comments of a thread, you can set the `deleteComments` option to `true`.
+     * @param id The thread id
+     * @param options A set of options that control how the thread is deleted
+     * @returns The deleted thread or null if the thread is not found
+     */
+    deleteThread(id: TCollabThread['id'], options?: DeleteThreadOptions): TCollabThread | null | undefined;
+    /**
+     * Tries to restore a deleted thread
      * @param id The thread id
-     * @returns void
+     * @returns The restored thread or null if the thread is not found
      */
-    deleteThread(id: TCollabThread['id']): void;
+    restoreThread(id: TCollabThread['id']): TCollabThread | null;
     /**
      * Returns comments from a thread, either deleted or not
      * @param threadId The thread id

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;
+    deletedAt: number | null;
     resolvedAt?: string;
     comments: TCollabComment<CommentData>[];
     deletedComments: TCollabComment<CommentData>[];
@@ -156,3 +157,30 @@ export type DeleteCommentOptions = {
      */
     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/server/src/MessageReceiver.d.ts

@@ -8,6 +8,6 @@ export declare class MessageReceiver {
     defaultTransactionOrigin?: string;
     constructor(message: IncomingMessage, logger: Debugger, defaultTransactionOrigin?: string);
     apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
-    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 1 | 2;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/common",
   "description": "shared code for multiple Hocuspocus packages",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus"