@hocuspocus/provider 2.14.0 → 2.15.0

package/dist/hocuspocus-provider.esm.js

@@ -2824,6 +2824,13 @@ const defaultDeleteCommentOptions = {
     deleteContent: false,
     deleteThread: false,
 };
+const defaultGetThreadsOptions = {
+    types: ['unarchived'],
+};
+const defaultDeleteThreadOptions = {
+    deleteComments: false,
+    force: false,
+};
 class TiptapCollabProvider extends HocuspocusProvider {
     constructor(configuration) {
         if (!configuration.websocketProvider) {
@@ -2889,10 +2896,24 @@ class TiptapCollabProvider extends HocuspocusProvider {
     }
     /**
      * 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() {
-        return this.getYThreads().toJSON();
+    getThreads(options) {
+        const { types } = { ...defaultGetThreadsOptions, ...options };
+        const threads = this.getYThreads().toJSON();
+        if ((types === null || types === void 0 ? void 0 : types.includes('archived')) && (types === null || types === void 0 ? void 0 : types.includes('unarchived'))) {
+            return threads;
+        }
+        return threads.filter(currentThead => {
+            if ((types === null || types === void 0 ? void 0 : types.includes('archived')) && currentThead.deletedAt) {
+                return true;
+            }
+            if ((types === null || types === void 0 ? void 0 : types.includes('unarchived')) && !currentThead.deletedAt) {
+                return true;
+            }
+            return false;
+        });
     }
     /**
      * Find the index of a thread by its id
@@ -2903,7 +2924,7 @@ class TiptapCollabProvider extends HocuspocusProvider {
         let index = null;
         let i = 0;
         // eslint-disable-next-line no-restricted-syntax
-        for (const thread of this.getThreads()) {
+        for (const thread of this.getThreads({ types: ['archived', 'unarchived'] })) {
             if (thread.id === id) {
                 index = i;
                 break;
@@ -2949,6 +2970,7 @@ class TiptapCollabProvider extends HocuspocusProvider {
             thread.set('createdAt', (new Date()).toISOString());
             thread.set('comments', new Y.Array());
             thread.set('deletedComments', new Y.Array());
+            thread.set('deletedAt', null);
             this.getYThreads().push([thread]);
             createdThread = this.updateThread(String(thread.get('id')), data);
         });
@@ -2979,16 +3001,45 @@ class TiptapCollabProvider extends HocuspocusProvider {
         return updatedThread;
     }
     /**
-     * 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
-     * @returns void
+     * @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) {
+    deleteThread(id, options) {
+        const { deleteComments, force } = { ...defaultDeleteThreadOptions, ...options };
         const index = this.getThreadIndex(id);
         if (index === null) {
+            return null;
+        }
+        if (force) {
+            this.getYThreads().delete(index, 1);
             return;
         }
-        this.getYThreads().delete(index, 1);
+        const thread = this.getYThreads().get(index);
+        thread.set('deletedAt', (new Date()).toISOString());
+        if (deleteComments) {
+            thread.set('comments', new Y.Array());
+            thread.set('deletedComments', new Y.Array());
+        }
+        return thread.toJSON();
+    }
+    /**
+     * Tries to restore a deleted thread
+     * @param id The thread id
+     * @returns The restored thread or null if the thread is not found
+     */
+    restoreThread(id) {
+        const index = this.getThreadIndex(id);
+        if (index === null) {
+            return null;
+        }
+        const thread = this.getYThreads().get(index);
+        thread.set('deletedAt', null);
+        return thread.toJSON();
     }
     /**
      * Returns comments from a thread, either deleted or not