@liveblocks/core 2.5.1 → 2.6.0

package/dist/index.d.mts

@@ -1723,175 +1723,6 @@ declare type GetThreadsOptions<M extends BaseMetadata> = {
         metadata?: Partial<QueryMetadata<M>>;
     };
 };
-declare type CommentsApi<M extends BaseMetadata> = {
-    /**
-     * Returns the threads within the current room and their associated inbox notifications.
-     * It also returns the request date that can be used for subsequent polling.
-     *
-     * @example
-     * const {
-     *   threads,
-     *   inboxNotifications,
-     *   requestedAt
-     * } = await room.getThreads({ query: { resolved: false }});
-     */
-    getThreads(options?: GetThreadsOptions<M>): Promise<{
-        threads: ThreadData<M>[];
-        inboxNotifications: InboxNotificationData[];
-        requestedAt: Date;
-    }>;
-    /**
-     * Returns the updated and deleted threads and their associated inbox notifications since the requested date.
-     *
-     * @example
-     * const result = await room.getThreads();
-     * // ... //
-     * await room.getThreadsSince({ since: result.requestedAt });
-     */
-    getThreadsSince(options: {
-        since: Date;
-    }): Promise<{
-        threads: {
-            updated: ThreadData<M>[];
-            deleted: ThreadDeleteInfo[];
-        };
-        inboxNotifications: {
-            updated: InboxNotificationData[];
-            deleted: InboxNotificationDeleteInfo[];
-        };
-        requestedAt: Date;
-    }>;
-    /**
-     * Returns a thread and the associated inbox notification if it exists.
-     *
-     * @example
-     * const { thread, inboxNotification } = await room.getThread("th_xxx");
-     */
-    getThread(threadId: string): Promise<{
-        thread?: ThreadData<M>;
-        inboxNotification?: InboxNotificationData;
-    }>;
-    /**
-     * Creates a thread.
-     *
-     * @example
-     * const thread = await room.createThread({
-     *   body: {
-     *     version: 1,
-     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
-     *   },
-     * })
-     */
-    createThread(options: {
-        threadId?: string;
-        commentId?: string;
-        metadata: M | undefined;
-        body: CommentBody;
-    }): Promise<ThreadData<M>>;
-    /**
-     * Deletes a thread.
-     *
-     * @example
-     * await room.deleteThread("th_xxx");
-     */
-    deleteThread(threadId: string): Promise<void>;
-    /**
-     * Edits a thread's metadata.
-     * To delete an existing metadata property, set its value to `null`.
-     *
-     * @example
-     * await room.editThreadMetadata({ threadId: "th_xxx", metadata: { x: 100, y: 100 } })
-     */
-    editThreadMetadata(options: {
-        metadata: Patchable<M>;
-        threadId: string;
-    }): Promise<M>;
-    /**
-     * Marks a thread as resolved.
-     *
-     * @example
-     * await room.markThreadAsResolved("th_xxx");
-     */
-    markThreadAsResolved(threadId: string): Promise<void>;
-    /**
-     * Marks a thread as unresolved.
-     *
-     * @example
-     * await room.markThreadAsUnresolved("th_xxx");
-     */
-    markThreadAsUnresolved(threadId: string): Promise<void>;
-    /**
-     * Creates a comment.
-     *
-     * @example
-     * await room.createComment({
-     *   threadId: "th_xxx",
-     *   body: {
-     *     version: 1,
-     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
-     *   },
-     * });
-     */
-    createComment(options: {
-        threadId: string;
-        commentId?: string;
-        body: CommentBody;
-    }): Promise<CommentData>;
-    /**
-     * Edits a comment.
-     *
-     * @example
-     * await room.editComment({
-     *   threadId: "th_xxx",
-     *   commentId: "cm_xxx"
-     *   body: {
-     *     version: 1,
-     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
-     *   },
-     * });
-     */
-    editComment(options: {
-        threadId: string;
-        commentId: string;
-        body: CommentBody;
-    }): Promise<CommentData>;
-    /**
-     * Deletes a comment.
-     * If it is the last non-deleted comment, the thread also gets deleted.
-     *
-     * @example
-     * await room.deleteComment({
-     *   threadId: "th_xxx",
-     *   commentId: "cm_xxx"
-     * });
-     */
-    deleteComment(options: {
-        threadId: string;
-        commentId: string;
-    }): Promise<void>;
-    /**
-     * Adds a reaction from a comment for the current user.
-     *
-     * @example
-     * await room.addReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
-     */
-    addReaction(options: {
-        threadId: string;
-        commentId: string;
-        emoji: string;
-    }): Promise<CommentUserReaction>;
-    /**
-     * Removes a reaction from a comment.
-     *
-     * @example
-     * await room.removeReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
-     */
-    removeReaction(options: {
-        threadId: string;
-        commentId: string;
-        emoji: string;
-    }): Promise<void>;
-};
 /**
  * @private Widest-possible Room type, matching _any_ Room instance. Note that
  * this type is different from `Room`-without-type-arguments. That represents
@@ -2100,6 +1931,173 @@ declare type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extend
      * connection. If the room is not connected yet, initiate it.
      */
     reconnect(): void;
+    /**
+     * Returns the threads within the current room and their associated inbox notifications.
+     * It also returns the request date that can be used for subsequent polling.
+     *
+     * @example
+     * const {
+     *   threads,
+     *   inboxNotifications,
+     *   requestedAt
+     * } = await room.getThreads({ query: { resolved: false }});
+     */
+    getThreads(options?: GetThreadsOptions<M>): Promise<{
+        threads: ThreadData<M>[];
+        inboxNotifications: InboxNotificationData[];
+        requestedAt: Date;
+    }>;
+    /**
+     * Returns the updated and deleted threads and their associated inbox notifications since the requested date.
+     *
+     * @example
+     * const result = await room.getThreads();
+     * // ... //
+     * await room.getThreadsSince({ since: result.requestedAt });
+     */
+    getThreadsSince(options: {
+        since: Date;
+    }): Promise<{
+        threads: {
+            updated: ThreadData<M>[];
+            deleted: ThreadDeleteInfo[];
+        };
+        inboxNotifications: {
+            updated: InboxNotificationData[];
+            deleted: InboxNotificationDeleteInfo[];
+        };
+        requestedAt: Date;
+    }>;
+    /**
+     * Returns a thread and the associated inbox notification if it exists.
+     *
+     * @example
+     * const { thread, inboxNotification } = await room.getThread("th_xxx");
+     */
+    getThread(threadId: string): Promise<{
+        thread?: ThreadData<M>;
+        inboxNotification?: InboxNotificationData;
+    }>;
+    /**
+     * Creates a thread.
+     *
+     * @example
+     * const thread = await room.createThread({
+     *   body: {
+     *     version: 1,
+     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
+     *   },
+     * })
+     */
+    createThread(options: {
+        threadId?: string;
+        commentId?: string;
+        metadata: M | undefined;
+        body: CommentBody;
+    }): Promise<ThreadData<M>>;
+    /**
+     * Deletes a thread.
+     *
+     * @example
+     * await room.deleteThread("th_xxx");
+     */
+    deleteThread(threadId: string): Promise<void>;
+    /**
+     * Edits a thread's metadata.
+     * To delete an existing metadata property, set its value to `null`.
+     *
+     * @example
+     * await room.editThreadMetadata({ threadId: "th_xxx", metadata: { x: 100, y: 100 } })
+     */
+    editThreadMetadata(options: {
+        metadata: Patchable<M>;
+        threadId: string;
+    }): Promise<M>;
+    /**
+     * Marks a thread as resolved.
+     *
+     * @example
+     * await room.markThreadAsResolved("th_xxx");
+     */
+    markThreadAsResolved(threadId: string): Promise<void>;
+    /**
+     * Marks a thread as unresolved.
+     *
+     * @example
+     * await room.markThreadAsUnresolved("th_xxx");
+     */
+    markThreadAsUnresolved(threadId: string): Promise<void>;
+    /**
+     * Creates a comment.
+     *
+     * @example
+     * await room.createComment({
+     *   threadId: "th_xxx",
+     *   body: {
+     *     version: 1,
+     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
+     *   },
+     * });
+     */
+    createComment(options: {
+        threadId: string;
+        commentId?: string;
+        body: CommentBody;
+    }): Promise<CommentData>;
+    /**
+     * Edits a comment.
+     *
+     * @example
+     * await room.editComment({
+     *   threadId: "th_xxx",
+     *   commentId: "cm_xxx"
+     *   body: {
+     *     version: 1,
+     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
+     *   },
+     * });
+     */
+    editComment(options: {
+        threadId: string;
+        commentId: string;
+        body: CommentBody;
+    }): Promise<CommentData>;
+    /**
+     * Deletes a comment.
+     * If it is the last non-deleted comment, the thread also gets deleted.
+     *
+     * @example
+     * await room.deleteComment({
+     *   threadId: "th_xxx",
+     *   commentId: "cm_xxx"
+     * });
+     */
+    deleteComment(options: {
+        threadId: string;
+        commentId: string;
+    }): Promise<void>;
+    /**
+     * Adds a reaction from a comment for the current user.
+     *
+     * @example
+     * await room.addReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
+     */
+    addReaction(options: {
+        threadId: string;
+        commentId: string;
+        emoji: string;
+    }): Promise<CommentUserReaction>;
+    /**
+     * Removes a reaction from a comment.
+     *
+     * @example
+     * await room.removeReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
+     */
+    removeReaction(options: {
+        threadId: string;
+        commentId: string;
+        emoji: string;
+    }): Promise<void>;
     /**
      * Gets the user's notification settings for the current room.
      *
@@ -2118,7 +2116,7 @@ declare type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extend
      * Internal use only. Signature might change in the future.
      */
     markInboxNotificationAsRead(notificationId: string): Promise<void>;
-} & CommentsApi<M>;
+};
 declare type Provider = {
     synced: boolean;
     getStatus: () => "loading" | "synchronizing" | "synchronized";

package/dist/index.d.ts

@@ -1723,175 +1723,6 @@ declare type GetThreadsOptions<M extends BaseMetadata> = {
         metadata?: Partial<QueryMetadata<M>>;
     };
 };
-declare type CommentsApi<M extends BaseMetadata> = {
-    /**
-     * Returns the threads within the current room and their associated inbox notifications.
-     * It also returns the request date that can be used for subsequent polling.
-     *
-     * @example
-     * const {
-     *   threads,
-     *   inboxNotifications,
-     *   requestedAt
-     * } = await room.getThreads({ query: { resolved: false }});
-     */
-    getThreads(options?: GetThreadsOptions<M>): Promise<{
-        threads: ThreadData<M>[];
-        inboxNotifications: InboxNotificationData[];
-        requestedAt: Date;
-    }>;
-    /**
-     * Returns the updated and deleted threads and their associated inbox notifications since the requested date.
-     *
-     * @example
-     * const result = await room.getThreads();
-     * // ... //
-     * await room.getThreadsSince({ since: result.requestedAt });
-     */
-    getThreadsSince(options: {
-        since: Date;
-    }): Promise<{
-        threads: {
-            updated: ThreadData<M>[];
-            deleted: ThreadDeleteInfo[];
-        };
-        inboxNotifications: {
-            updated: InboxNotificationData[];
-            deleted: InboxNotificationDeleteInfo[];
-        };
-        requestedAt: Date;
-    }>;
-    /**
-     * Returns a thread and the associated inbox notification if it exists.
-     *
-     * @example
-     * const { thread, inboxNotification } = await room.getThread("th_xxx");
-     */
-    getThread(threadId: string): Promise<{
-        thread?: ThreadData<M>;
-        inboxNotification?: InboxNotificationData;
-    }>;
-    /**
-     * Creates a thread.
-     *
-     * @example
-     * const thread = await room.createThread({
-     *   body: {
-     *     version: 1,
-     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
-     *   },
-     * })
-     */
-    createThread(options: {
-        threadId?: string;
-        commentId?: string;
-        metadata: M | undefined;
-        body: CommentBody;
-    }): Promise<ThreadData<M>>;
-    /**
-     * Deletes a thread.
-     *
-     * @example
-     * await room.deleteThread("th_xxx");
-     */
-    deleteThread(threadId: string): Promise<void>;
-    /**
-     * Edits a thread's metadata.
-     * To delete an existing metadata property, set its value to `null`.
-     *
-     * @example
-     * await room.editThreadMetadata({ threadId: "th_xxx", metadata: { x: 100, y: 100 } })
-     */
-    editThreadMetadata(options: {
-        metadata: Patchable<M>;
-        threadId: string;
-    }): Promise<M>;
-    /**
-     * Marks a thread as resolved.
-     *
-     * @example
-     * await room.markThreadAsResolved("th_xxx");
-     */
-    markThreadAsResolved(threadId: string): Promise<void>;
-    /**
-     * Marks a thread as unresolved.
-     *
-     * @example
-     * await room.markThreadAsUnresolved("th_xxx");
-     */
-    markThreadAsUnresolved(threadId: string): Promise<void>;
-    /**
-     * Creates a comment.
-     *
-     * @example
-     * await room.createComment({
-     *   threadId: "th_xxx",
-     *   body: {
-     *     version: 1,
-     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
-     *   },
-     * });
-     */
-    createComment(options: {
-        threadId: string;
-        commentId?: string;
-        body: CommentBody;
-    }): Promise<CommentData>;
-    /**
-     * Edits a comment.
-     *
-     * @example
-     * await room.editComment({
-     *   threadId: "th_xxx",
-     *   commentId: "cm_xxx"
-     *   body: {
-     *     version: 1,
-     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
-     *   },
-     * });
-     */
-    editComment(options: {
-        threadId: string;
-        commentId: string;
-        body: CommentBody;
-    }): Promise<CommentData>;
-    /**
-     * Deletes a comment.
-     * If it is the last non-deleted comment, the thread also gets deleted.
-     *
-     * @example
-     * await room.deleteComment({
-     *   threadId: "th_xxx",
-     *   commentId: "cm_xxx"
-     * });
-     */
-    deleteComment(options: {
-        threadId: string;
-        commentId: string;
-    }): Promise<void>;
-    /**
-     * Adds a reaction from a comment for the current user.
-     *
-     * @example
-     * await room.addReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
-     */
-    addReaction(options: {
-        threadId: string;
-        commentId: string;
-        emoji: string;
-    }): Promise<CommentUserReaction>;
-    /**
-     * Removes a reaction from a comment.
-     *
-     * @example
-     * await room.removeReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
-     */
-    removeReaction(options: {
-        threadId: string;
-        commentId: string;
-        emoji: string;
-    }): Promise<void>;
-};
 /**
  * @private Widest-possible Room type, matching _any_ Room instance. Note that
  * this type is different from `Room`-without-type-arguments. That represents
@@ -2100,6 +1931,173 @@ declare type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extend
      * connection. If the room is not connected yet, initiate it.
      */
     reconnect(): void;
+    /**
+     * Returns the threads within the current room and their associated inbox notifications.
+     * It also returns the request date that can be used for subsequent polling.
+     *
+     * @example
+     * const {
+     *   threads,
+     *   inboxNotifications,
+     *   requestedAt
+     * } = await room.getThreads({ query: { resolved: false }});
+     */
+    getThreads(options?: GetThreadsOptions<M>): Promise<{
+        threads: ThreadData<M>[];
+        inboxNotifications: InboxNotificationData[];
+        requestedAt: Date;
+    }>;
+    /**
+     * Returns the updated and deleted threads and their associated inbox notifications since the requested date.
+     *
+     * @example
+     * const result = await room.getThreads();
+     * // ... //
+     * await room.getThreadsSince({ since: result.requestedAt });
+     */
+    getThreadsSince(options: {
+        since: Date;
+    }): Promise<{
+        threads: {
+            updated: ThreadData<M>[];
+            deleted: ThreadDeleteInfo[];
+        };
+        inboxNotifications: {
+            updated: InboxNotificationData[];
+            deleted: InboxNotificationDeleteInfo[];
+        };
+        requestedAt: Date;
+    }>;
+    /**
+     * Returns a thread and the associated inbox notification if it exists.
+     *
+     * @example
+     * const { thread, inboxNotification } = await room.getThread("th_xxx");
+     */
+    getThread(threadId: string): Promise<{
+        thread?: ThreadData<M>;
+        inboxNotification?: InboxNotificationData;
+    }>;
+    /**
+     * Creates a thread.
+     *
+     * @example
+     * const thread = await room.createThread({
+     *   body: {
+     *     version: 1,
+     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
+     *   },
+     * })
+     */
+    createThread(options: {
+        threadId?: string;
+        commentId?: string;
+        metadata: M | undefined;
+        body: CommentBody;
+    }): Promise<ThreadData<M>>;
+    /**
+     * Deletes a thread.
+     *
+     * @example
+     * await room.deleteThread("th_xxx");
+     */
+    deleteThread(threadId: string): Promise<void>;
+    /**
+     * Edits a thread's metadata.
+     * To delete an existing metadata property, set its value to `null`.
+     *
+     * @example
+     * await room.editThreadMetadata({ threadId: "th_xxx", metadata: { x: 100, y: 100 } })
+     */
+    editThreadMetadata(options: {
+        metadata: Patchable<M>;
+        threadId: string;
+    }): Promise<M>;
+    /**
+     * Marks a thread as resolved.
+     *
+     * @example
+     * await room.markThreadAsResolved("th_xxx");
+     */
+    markThreadAsResolved(threadId: string): Promise<void>;
+    /**
+     * Marks a thread as unresolved.
+     *
+     * @example
+     * await room.markThreadAsUnresolved("th_xxx");
+     */
+    markThreadAsUnresolved(threadId: string): Promise<void>;
+    /**
+     * Creates a comment.
+     *
+     * @example
+     * await room.createComment({
+     *   threadId: "th_xxx",
+     *   body: {
+     *     version: 1,
+     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
+     *   },
+     * });
+     */
+    createComment(options: {
+        threadId: string;
+        commentId?: string;
+        body: CommentBody;
+    }): Promise<CommentData>;
+    /**
+     * Edits a comment.
+     *
+     * @example
+     * await room.editComment({
+     *   threadId: "th_xxx",
+     *   commentId: "cm_xxx"
+     *   body: {
+     *     version: 1,
+     *     content: [{ type: "paragraph", children: [{ text: "Hello" }] }],
+     *   },
+     * });
+     */
+    editComment(options: {
+        threadId: string;
+        commentId: string;
+        body: CommentBody;
+    }): Promise<CommentData>;
+    /**
+     * Deletes a comment.
+     * If it is the last non-deleted comment, the thread also gets deleted.
+     *
+     * @example
+     * await room.deleteComment({
+     *   threadId: "th_xxx",
+     *   commentId: "cm_xxx"
+     * });
+     */
+    deleteComment(options: {
+        threadId: string;
+        commentId: string;
+    }): Promise<void>;
+    /**
+     * Adds a reaction from a comment for the current user.
+     *
+     * @example
+     * await room.addReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
+     */
+    addReaction(options: {
+        threadId: string;
+        commentId: string;
+        emoji: string;
+    }): Promise<CommentUserReaction>;
+    /**
+     * Removes a reaction from a comment.
+     *
+     * @example
+     * await room.removeReaction({ threadId: "th_xxx", commentId: "cm_xxx", emoji: "👍" })
+     */
+    removeReaction(options: {
+        threadId: string;
+        commentId: string;
+        emoji: string;
+    }): Promise<void>;
     /**
      * Gets the user's notification settings for the current room.
      *
@@ -2118,7 +2116,7 @@ declare type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extend
      * Internal use only. Signature might change in the future.
      */
     markInboxNotificationAsRead(notificationId: string): Promise<void>;
-} & CommentsApi<M>;
+};
 declare type Provider = {
     synced: boolean;
     getStatus: () => "loading" | "synchronizing" | "synchronized";