@univerjs/sheets-thread-comment 0.6.1 → 0.6.2

package/lib/types/facade/f-event.d.ts

@@ -11,10 +11,12 @@ interface ICommentEventMixin {
      * @see {@link ISheetCommentAddEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.CommentAdded, (event) => {
-     *     const { comment, workbook, worksheet, row, col } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentAdded, (params) => {
+     *   const { comment, workbook, worksheet, row, col } = params;
+     *   console.log(params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly CommentAdded: 'CommentAdded';
@@ -23,10 +25,15 @@ interface ICommentEventMixin {
      * @see {@link IBeforeSheetCommentAddEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.BeforeCommentAdd, (event) => {
-     *     const { comment, workbook, worksheet, row, col } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentAdd, (params) => {
+     *   const { comment, workbook, worksheet, row, col } = params;
+     *   console.log(params);
+     *
+     *   // Cancel the comment add operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeCommentAdd: 'BeforeCommentAdd';
@@ -35,10 +42,12 @@ interface ICommentEventMixin {
      * @see {@link ISheetCommentUpdateEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.CommentUpdated, (event) => {
-     *     const { comment, workbook, worksheet, row, col } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentUpdated, (params) => {
+     *   const { comment, workbook, worksheet, row, col } = params;
+     *   console.log(params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly CommentUpdated: 'CommentUpdated';
@@ -47,10 +56,15 @@ interface ICommentEventMixin {
      * @see {@link IBeforeSheetCommentUpdateEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.BeforeCommentUpdate, (event) => {
-     *     const { comment, workbook, worksheet, row, col, newContent } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentUpdate, (params) => {
+     *   const { comment, workbook, worksheet, row, col, newContent } = params;
+     *   console.log(params);
+     *
+     *   // Cancel the comment update operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeCommentUpdate: 'BeforeCommentUpdate';
@@ -59,10 +73,12 @@ interface ICommentEventMixin {
      * @see {@link ISheetCommentDeleteEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.CommentDeleted, (event) => {
-     *     const { commentId, workbook, worksheet } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentDeleted, (params) => {
+     *   const { commentId, workbook, worksheet } = params;
+     *   console.log(params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly CommentDeleted: 'CommentDeleted';
@@ -71,22 +87,29 @@ interface ICommentEventMixin {
      * @see {@link IBeforeSheetCommentDeleteEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.BeforeCommentDeleted, (event) => {
-     *     const { commentId, workbook, worksheet } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentDelete, (params) => {
+     *   const { comment, workbook, worksheet, row, col } = params;
+     *   console.log(params);
+     *
+     *   // Cancel the comment delete operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
-    readonly BeforeCommentDeleted: 'BeforeCommentDeleted';
+    readonly BeforeCommentDelete: 'BeforeCommentDelete';
     /**
      * Event fired after comment resolve
      * @see {@link ISheetCommentResolveEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.CommentResolved, (event) => {
-     *     const { comment, row, col, resolved, workbook, worksheet } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentResolved, (params) => {
+     *   const { comment, row, col, resolved, workbook, worksheet } = params;
+     *   console.log(params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly CommentResolved: 'CommentResolved';
@@ -95,10 +118,15 @@ interface ICommentEventMixin {
      * @see {@link ISheetCommentResolveEvent}
      * @example
      * ```ts
-     * univerAPI.addEventListener(CommentEvent.BeforeCommentResolve, (event) => {
-     *     const { comment, row, col, resolved, workbook, worksheet } = event;
-     *     console.log(event);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentResolve, (params) => {
+     *   const { comment, row, col, resolved, workbook, worksheet } = params;
+     *   console.log(params);
+     *
+     *   // Cancel the comment resolve operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     readonly BeforeCommentResolve: 'BeforeCommentResolve';
@@ -112,7 +140,7 @@ export declare class FCommentEvent extends FEventName {
     get CommentUpdated(): 'CommentUpdated';
     get BeforeCommentUpdate(): 'BeforeCommentUpdate';
     get CommentDeleted(): 'CommentDeleted';
-    get BeforeCommentDeleted(): 'BeforeCommentDeleted';
+    get BeforeCommentDelete(): 'BeforeCommentDelete';
     get CommentResolved(): 'CommentResolved';
     get BeforeCommentResolve(): 'BeforeCommentResolve';
 }
@@ -243,7 +271,7 @@ export interface ISheetCommentEventConfig {
     CommentAdded: ISheetCommentAddEvent;
     BeforeCommentUpdate: IBeforeSheetCommentUpdateEvent;
     CommentUpdated: ISheetCommentUpdateEvent;
-    BeforeCommentDeleted: IBeforeSheetCommentDeleteEvent;
+    BeforeCommentDelete: IBeforeSheetCommentDeleteEvent;
     CommentDeleted: ISheetCommentDeleteEvent;
     BeforeCommentResolve: ISheetCommentResolveEvent;
     CommentResolved: ISheetCommentResolveEvent;

package/lib/types/facade/f-thread-comment.d.ts

@@ -14,7 +14,8 @@ export declare class FTheadCommentItem {
      * @returns {FTheadCommentItem} A new instance of FTheadCommentItem
      * @example
      * ```ts
-     * const comment = univerAPI.newTheadComment();
+     * const commentBuilder = univerAPI.newTheadComment();
+     * console.log(commentBuilder);
      * ```
      */
     static create(comment?: IThreadComment): FTheadCommentItem;
@@ -24,10 +25,8 @@ export declare class FTheadCommentItem {
      * @returns {string} The person id of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const personId = comment.personId;
+     * const commentBuilder = univerAPI.newTheadComment();
+     * console.log(commentBuilder.personId);
      * ```
      */
     get personId(): string;
@@ -36,10 +35,8 @@ export declare class FTheadCommentItem {
      * @returns {string} The date time of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const dateTime = comment.dateTime;
+     * const commentBuilder = univerAPI.newTheadComment();
+     * console.log(commentBuilder.dateTime);
      * ```
      */
     get dateTime(): string;
@@ -48,10 +45,8 @@ export declare class FTheadCommentItem {
      * @returns {RichTextValue} The content of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const content = comment.content;
+     * const commentBuilder = univerAPI.newTheadComment();
+     * console.log(commentBuilder.content);
      * ```
      */
     get content(): RichTextValue;
@@ -60,10 +55,8 @@ export declare class FTheadCommentItem {
      * @returns {string} The id of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const id = comment.id;
+     * const commentBuilder = univerAPI.newTheadComment();
+     * console.log(commentBuilder.id);
      * ```
      */
     get id(): string;
@@ -72,10 +65,8 @@ export declare class FTheadCommentItem {
      * @returns {string} The thread id of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const threadId = comment.threadId;
+     * const commentBuilder = univerAPI.newTheadComment();
+     * console.log(commentBuilder.threadId);
      * ```
      */
     get threadId(): string;
@@ -84,10 +75,9 @@ export declare class FTheadCommentItem {
      * @returns {FTheadCommentBuilder} The comment builder
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const newComment = comment.copy();
+     * const commentBuilder = univerAPI.newTheadComment();
+     * const newCommentBuilder = commentBuilder.copy();
+     * console.log(newCommentBuilder);
      * ```
      */
     copy(): FTheadCommentBuilder;
@@ -100,44 +90,87 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
     /**
      * Set the content of the comment
      * @param {IDocumentBody | RichTextValue} content The content of the comment
-     * @returns {FTheadCommentBuilder} The comment builder
+     * @returns {FTheadCommentBuilder} The comment builder for chaining
      * @example
      * ```ts
-     * const comment = univerAPI.newTheadComment()
-     *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText);
+     * console.log(commentBuilder.content);
+     *
+     * // Add the comment to the cell A1
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const cell = fWorksheet.getRange('A1');
+     * const result = await cell.addCommentAsync(commentBuilder);
+     * console.log(result);
      * ```
      */
     setContent(content: IDocumentBody | RichTextValue): FTheadCommentBuilder;
     /**
      * Set the person id of the comment
      * @param {string} userId The person id of the comment
-     * @returns {FTheadCommentBuilder} The comment builder
+     * @returns {FTheadCommentBuilder} The comment builder for chaining
      * @example
      * ```ts
-     * const comment = univerAPI.newTheadComment()
-     *   .setPersonId('123');
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setPersonId('mock-user-id');
+     * console.log(commentBuilder.personId);
+     *
+     * // Add the comment to the cell A1
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const cell = fWorksheet.getRange('A1');
+     * const result = await cell.addCommentAsync(commentBuilder);
+     * console.log(result);
      * ```
      */
     setPersonId(userId: string): FTheadCommentBuilder;
     /**
      * Set the date time of the comment
      * @param {Date} date The date time of the comment
-     * @returns {FTheadCommentBuilder} The comment builder
+     * @returns {FTheadCommentBuilder} The comment builder for chaining
      * @example
      * ```ts
-     * const comment = univerAPI.newTheadComment()
-     *   .setDateTime(new Date());
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setDateTime(new Date('2025-02-21 14:22:22'));
+     * console.log(commentBuilder.dateTime);
+     *
+     * // Add the comment to the cell A1
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const cell = fWorksheet.getRange('A1');
+     * const result = await cell.addCommentAsync(commentBuilder);
+     * console.log(result);
      * ```
      */
     setDateTime(date: Date): FTheadCommentBuilder;
     /**
      * Set the id of the comment
      * @param {string} id The id of the comment
-     * @returns {FTheadCommentBuilder} The comment builder
+     * @returns {FTheadCommentBuilder} The comment builder for chaining
      * @example
      * ```ts
-     * const comment = univerAPI.newTheadComment()
-     *   .setId('123');
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setId('mock-comment-id');
+     * console.log(commentBuilder.id);
+     *
+     * // Add the comment to the cell A1
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const cell = fWorksheet.getRange('A1');
+     * const result = await cell.addCommentAsync(commentBuilder);
+     * console.log(result);
      * ```
      */
     setId(id: string): FTheadCommentBuilder;
@@ -147,8 +180,19 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @returns {FTheadCommentBuilder} The comment builder
      * @example
      * ```ts
-     * const comment = univerAPI.newTheadComment()
-     *   .setThreadId('123');
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setThreadId('mock-thread-id');
+     * console.log(commentBuilder.threadId);
+     *
+     * // Add the comment to the cell A1
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const cell = fWorksheet.getRange('A1');
+     * const result = await cell.addCommentAsync(commentBuilder);
+     * console.log(result);
      * ```
      */
     setThreadId(threadId: string): FTheadCommentBuilder;
@@ -157,9 +201,15 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @returns {IThreadComment} The comment
      * @example
      * ```ts
+     * const richText = univerAPI.newRichText().insertText('hello univer');
      * const comment = univerAPI.newTheadComment()
-     *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'))
+     *   .setContent(richText)
+     *   .setPersonId('mock-user-id')
+     *   .setDateTime(new Date('2025-02-21 14:22:22'))
+     *   .setId('mock-comment-id')
+     *   .setThreadId('mock-thread-id')
      *   .build();
+     * console.log(comment);
      * ```
      */
     build(): IThreadComment;
@@ -185,10 +235,12 @@ export declare class FThreadComment {
      * @returns {boolean} Whether the comment is a root comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const isRoot = comment.getIsRoot();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const comments = fWorksheet.getComments();
+     * comments.forEach((comment) => {
+     *   console.log(comment.getIsRoot());
+     * });
      * ```
      */
     getIsRoot(): boolean;
@@ -197,10 +249,12 @@ export declare class FThreadComment {
      * @returns {IBaseComment} The comment data
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const commentData = comment.getCommentData();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const comments = fWorksheet.getComments();
+     * comments.forEach((comment) => {
+     *   console.log(comment.getCommentData());
+     * });
      * ```
      */
     getCommentData(): IBaseComment;
@@ -209,10 +263,17 @@ export declare class FThreadComment {
      * @returns {FThreadComment[]} the replies of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const replies = comment.getReplies();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const comments = fWorksheet.getComments();
+     * comments.forEach((comment) => {
+     *   if (comment.getIsRoot()) {
+     *     const replies = comment.getReplies();
+     *     replies.forEach((reply) => {
+     *       console.log(reply.getCommentData());
+     *     });
+     *   }
+     * });
      * ```
      */
     getReplies(): FThreadComment[] | undefined;
@@ -221,10 +282,12 @@ export declare class FThreadComment {
      * @returns {FRange | null} The range of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const range = comment.getRange();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const comments = fWorksheet.getComments();
+     * comments.forEach((comment) => {
+     *   console.log(comment.getRange().getA1Notation());
+     * });
      * ```
      */
     getRange(): FRange | null;
@@ -237,22 +300,27 @@ export declare class FThreadComment {
      * @returns {RichTextValue} The rich text of the comment
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const richText = comment.getRichText();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const comments = fWorksheet.getComments();
+     * comments.forEach((comment) => {
+     *   console.log(comment.getRichText());
+     * });
      * ```
      */
     getRichText(): RichTextValue;
     /**
      * Delete the comment and it's replies
-     * @returns {Promise<boolean>} success or not
+     * @returns {Promise<boolean>} Whether the comment is deleted successfully
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const success = await comment.deleteAsync();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const comments = fWorksheet.getComments();
+     *
+     * // Delete the first comment
+     * const result = await comments[0]?.deleteAsync();
+     * console.log(result);
      * ```
      */
     deleteAsync(): Promise<boolean>;
@@ -267,13 +335,27 @@ export declare class FThreadComment {
     /**
      * Update the comment content
      * @param {IDocumentBody | RichTextValue} content The new content of the comment
-     * @returns {Promise<boolean>} success or not
+     * @returns {Promise<boolean>} Whether the comment is updated successfully
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const success = await comment.updateAsync(univerAPI.newRichText().insertText('hello zhangsan'));
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setId('mock-comment-id');
+     * const cell = fWorksheet.getRange('A1');
+     * await cell.addCommentAsync(commentBuilder);
+     *
+     * // Update the comment after 3 seconds
+     * setTimeout(async () => {
+     *   const comment = fWorksheet.getCommentById('mock-comment-id');
+     *   const newRichText = univerAPI.newRichText().insertText('Hello Univer AI');
+     *   const result = await comment.updateAsync(newRichText);
+     *   console.log(result);
+     * }, 3000);
      * ```
      */
     updateAsync(content: IDocumentBody | RichTextValue): Promise<boolean>;
@@ -284,30 +366,52 @@ export declare class FThreadComment {
     /**
      * Resolve the comment
      * @param {boolean} resolved Whether the comment is resolved
-     * @returns {Promise<boolean>} success or not
+     * @returns {Promise<boolean>} Set the comment to resolved or not operation result
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
-     * const success = await comment.resolveAsync(true);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setId('mock-comment-id');
+     * const cell = fWorksheet.getRange('A1');
+     * await cell.addCommentAsync(commentBuilder);
+     *
+     * // Resolve the comment after 3 seconds
+     * setTimeout(async () => {
+     *   const comment = fWorksheet.getCommentById('mock-comment-id');
+     *   const result = await comment.resolveAsync(true);
+     *   console.log(result);
+     * }, 3000);
      * ```
      */
     resolveAsync(resolved?: boolean): Promise<boolean>;
     /**
      * Reply to the comment
      * @param {FTheadCommentBuilder} comment The comment to reply to
-     * @returns {Promise<boolean>} success or not
+     * @returns {Promise<boolean>} Whether the comment is replied successfully
      * @example
      * ```ts
-     * const comment = univerAPI.getActiveWorkbook()
-     *   .getSheetById(sheetId)
-     *   .getCommentById(commentId);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
      *
-     * const reply = univerAPI.newTheadComment()
-     *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setId('mock-comment-id');
+     * const cell = fWorksheet.getRange('A1');
+     * await cell.addCommentAsync(commentBuilder);
      *
-     * const success = await comment.replyAsync(reply);
+     * // Reply to the comment
+     * const replyText = univerAPI.newRichText().insertText('Hello Univer AI');
+     * const reply = univerAPI.newTheadComment().setContent(replyText);
+     * const comment = fWorksheet.getCommentById('mock-comment-id');
+     * const result = await comment.replyAsync(reply);
+     * console.log(result);
      * ```
      */
     replyAsync(comment: FTheadCommentBuilder): Promise<boolean>;

package/lib/types/facade/f-univer.d.ts

@@ -8,27 +8,41 @@ import { FTheadCommentBuilder } from './f-thread-comment';
  */
 export interface IFUniverCommentMixin {
     /**
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentAdded, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentAdded, (params) => {})` as instead
      */
     onCommentAdded(callback: (event: ISheetCommentAddEvent) => void): IDisposable;
     /**
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentUpdated, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentUpdated, (params) => {})` as instead
      */
     onCommentUpdated(callback: (event: ISheetCommentUpdateEvent) => void): IDisposable;
     /**
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentDeleted, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentDeleted, (params) => {})` as instead
      */
     onCommentDeleted(callback: (event: ISheetCommentDeleteEvent) => void): IDisposable;
     /**
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentResolved, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommentResolved, (params) => {})` as instead
      */
     onCommentResolved(callback: (event: ISheetCommentResolveEvent) => void): IDisposable;
     /**
-     * create a new thread comment
-     * @returns {FTheadCommentBuilder} thead comment builder
+     * Create a new thread comment
+     * @returns {FTheadCommentBuilder} The thead comment builder
      * @example
      * ```ts
-     * const comment = univerAPI.newTheadComment().setContent(univerAPI.newRichText().insertText('hello zhangsan'));
+     * // Create a new comment
+     * const richText = univerAPI.newRichText().insertText('hello univer');
+     * const commentBuilder = univerAPI.newTheadComment()
+     *   .setContent(richText)
+     *   .setPersonId('mock-user-id')
+     *   .setDateTime(new Date('2025-02-21 14:22:22'))
+     *   .setId('mock-comment-id')
+     *   .setThreadId('mock-thread-id');
+     *
+     * // Add the comment to the cell A1
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const cell = fWorksheet.getRange('A1');
+     * const result = await cell.addCommentAsync(commentBuilder);
+     * console.log(result);
      * ```
      */
     newTheadComment(): FTheadCommentBuilder;