@univerjs/sheets-thread-comment 0.5.5 → 0.6.0-experimental.20250125-1d060b9

package/lib/es/facade.js

@@ -45,8 +45,8 @@ class T {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const personId = comment.personId;
    * ```
    */
@@ -59,8 +59,8 @@ class T {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const dateTime = comment.dateTime;
    * ```
    */
@@ -73,8 +73,8 @@ class T {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const content = comment.content;
    * ```
    */
@@ -87,8 +87,8 @@ class T {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const id = comment.id;
    * ```
    */
@@ -101,8 +101,8 @@ class T {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const threadId = comment.threadId;
    * ```
    */
@@ -115,8 +115,8 @@ class T {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const newComment = comment.copy();
    * ```
    */
@@ -135,7 +135,7 @@ class U extends T {
    * @example
    * ```ts
    * const comment = univerAPI.newTheadComment()
-   *  .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
+   *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
    * ```
    */
   setContent(e) {
@@ -148,7 +148,7 @@ class U extends T {
    * @example
    * ```ts
    * const comment = univerAPI.newTheadComment()
-   *  .setPersonId('123');
+   *   .setPersonId('123');
    * ```
    */
   setPersonId(e) {
@@ -161,7 +161,7 @@ class U extends T {
    * @example
    * ```ts
    * const comment = univerAPI.newTheadComment()
-   *  .setDateTime(new Date());
+   *   .setDateTime(new Date());
    * ```
    */
   setDateTime(e) {
@@ -174,7 +174,7 @@ class U extends T {
    * @example
    * ```ts
    * const comment = univerAPI.newTheadComment()
-   *  .setId('123');
+   *   .setId('123');
    * ```
    */
   setId(e) {
@@ -187,7 +187,7 @@ class U extends T {
    * @example
    * ```ts
    * const comment = univerAPI.newTheadComment()
-   *  .setThreadId('123');
+   *   .setThreadId('123');
    * ```
    */
   setThreadId(e) {
@@ -199,8 +199,8 @@ class U extends T {
    * @example
    * ```ts
    * const comment = univerAPI.newTheadComment()
-   *  .setContent(univerAPI.newRichText().insertText('hello zhangsan'))
-   *  .build();
+   *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'))
+   *   .build();
    * ```
    */
   build() {
@@ -208,6 +208,9 @@ class U extends T {
   }
 }
 let i = class {
+  /**
+   * @ignore
+   */
   constructor(r, e, t, n, o, m, s) {
     this._thread = r, this._parent = e, this._injector = t, this._commandService = n, this._univerInstanceService = o, this._threadCommentModel = m, this._userManagerService = s;
   }
@@ -218,12 +221,12 @@ let i = class {
   }
   /**
    * Whether the comment is a root comment
-   * @returns Whether the comment is a root comment
+   * @returns {boolean} Whether the comment is a root comment
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const isRoot = comment.getIsRoot();
    * ```
    */
@@ -232,12 +235,12 @@ let i = class {
   }
   /**
    * Get the comment data
-   * @returns The comment data
+   * @returns {IBaseComment} The comment data
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const commentData = comment.getCommentData();
    * ```
    */
@@ -247,12 +250,12 @@ let i = class {
   }
   /**
    * Get the replies of the comment
-   * @returns the replies of the comment
+   * @returns {FThreadComment[]} the replies of the comment
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const replies = comment.getReplies();
    * ```
    */
@@ -263,12 +266,12 @@ let i = class {
   }
   /**
    * Get the range of the comment
-   * @returns The range of the comment
+   * @returns {FRange | null} The range of the comment
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const range = comment.getRange();
    * ```
    */
@@ -282,6 +285,7 @@ let i = class {
     const t = this._getRef();
     return this._injector.createInstance(x, r, e, t);
   }
+  // eslint-disable-next-line
   /**
    * @deprecated use `getRichText` as instead
    */
@@ -294,8 +298,8 @@ let i = class {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const richText = comment.getRichText();
    * ```
    */
@@ -309,8 +313,8 @@ let i = class {
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const success = await comment.deleteAsync();
    * ```
    */
@@ -324,14 +328,15 @@ let i = class {
       }
     );
   }
+  // eslint-disable-next-line
   /**
    * @deprecated use `deleteAsync` as instead.
    */
   delete() {
     return this.deleteAsync();
   }
+  // eslint-disable-next-line
   /**
-   * @param content
    * @deprecated use `updateAsync` as instead
    */
   async update(r) {
@@ -339,13 +344,13 @@ let i = class {
   }
   /**
    * Update the comment content
-   * @param content The new content of the comment
-   * @returns success or not
+   * @param {IDocumentBody | RichTextValue} content The new content of the comment
+   * @returns {Promise<boolean>} success or not
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const success = await comment.updateAsync(univerAPI.newRichText().insertText('hello zhangsan'));
    * ```
    */
@@ -365,8 +370,8 @@ let i = class {
       }
     );
   }
+  // eslint-disable-next-line
   /**
-   * @param resolved
    * @deprecated use `resolveAsync` as instead
    */
   resolve(r) {
@@ -374,13 +379,13 @@ let i = class {
   }
   /**
    * Resolve the comment
-   * @param resolved Whether the comment is resolved
-   * @returns success or not
+   * @param {boolean} resolved Whether the comment is resolved
+   * @returns {Promise<boolean>} success or not
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    * const success = await comment.resolveAsync(true);
    * ```
    */
@@ -397,16 +402,16 @@ let i = class {
   }
   /**
    * Reply to the comment
-   * @param comment The comment to reply to
-   * @returns success or not
+   * @param {FTheadCommentBuilder} comment The comment to reply to
+   * @returns {Promise<boolean>} success or not
    * @example
    * ```ts
    * const comment = univerAPI.getActiveWorkbook()
-   *  .getSheetById(sheetId)
-   *  .getCommentById(commentId);
+   *   .getSheetById(sheetId)
+   *   .getCommentById(commentId);
    *
    * const reply = univerAPI.newTheadComment()
-   *  .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
+   *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
    *
    * const success = await comment.replyAsync(reply);
    * ```
@@ -506,6 +511,9 @@ class K extends x {
 }
 x.extend(K);
 class Q extends j {
+  /**
+   * @ignore
+   */
   _initialize() {
     Object.defineProperty(this, "_threadCommentModel", {
       get() {

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

@@ -1,6 +1,9 @@
 import { IEventBase, RichTextValue, FEventName } from '@univerjs/core';
 import { FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
 import { FTheadCommentItem, FThreadComment } from './f-thread-comment';
+/**
+ * @ignore
+ */
 interface ICommentEventMixin {
     /**
      * Event fired after comment added
@@ -99,6 +102,9 @@ interface ICommentEventMixin {
      */
     readonly BeforeCommentResolve: 'BeforeCommentResolve';
 }
+/**
+ * @ignore
+ */
 export declare class FCommentEvent extends FEventName {
     get CommentAdded(): 'CommentAdded';
     get BeforeCommentAdd(): 'BeforeCommentAdd';
@@ -228,6 +234,9 @@ export interface ISheetCommentResolveEvent extends IEventBase {
     /** The new resolve status */
     resolved: boolean;
 }
+/**
+ * @ignore
+ */
 export interface ISheetCommentEventConfig {
     BeforeCommentAdd: IBeforeSheetCommentAddEvent;
     CommentAdded: ISheetCommentAddEvent;

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

@@ -1,6 +1,9 @@
 import { IDocumentBody, Nullable } from '@univerjs/core';
 import { FRange } from '@univerjs/sheets/facade';
 import { FTheadCommentBuilder, FThreadComment } from './f-thread-comment';
+/**
+ * @ignore
+ */
 export interface IFRangeCommentMixin {
     /**
      * Get the comment of the start cell in the current range.
@@ -75,6 +78,9 @@ export interface IFRangeCommentMixin {
      */
     clearCommentsAsync(): Promise<boolean>;
 }
+/**
+ * @ignore
+ */
 export declare class FRangeCommentMixin extends FRange implements IFRangeCommentMixin {
     getComment(): Nullable<FThreadComment>;
     getComments(): FThreadComment[];

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

@@ -2,6 +2,10 @@ import { IDocumentBody, ICommandService, Injector, IUniverInstanceService, RichT
 import { IBaseComment, IThreadComment } from '@univerjs/thread-comment';
 import { SheetsThreadCommentModel } from '@univerjs/sheets-thread-comment';
 import { FRange } from '@univerjs/sheets/facade';
+/**
+ * An readonly class that represents a comment.
+ * @ignore
+ */
 export declare class FTheadCommentItem {
     protected _comment: IThreadComment;
     /**
@@ -21,8 +25,8 @@ export declare class FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const personId = comment.personId;
      * ```
      */
@@ -33,8 +37,8 @@ export declare class FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const dateTime = comment.dateTime;
      * ```
      */
@@ -45,8 +49,8 @@ export declare class FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const content = comment.content;
      * ```
      */
@@ -57,8 +61,8 @@ export declare class FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const id = comment.id;
      * ```
      */
@@ -69,8 +73,8 @@ export declare class FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const threadId = comment.threadId;
      * ```
      */
@@ -81,13 +85,16 @@ export declare class FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const newComment = comment.copy();
      * ```
      */
     copy(): FTheadCommentBuilder;
 }
+/**
+ * A builder for thread comment. use {@link FUniver} `univerAPI.newTheadComment()` to create a new builder.
+ */
 export declare class FTheadCommentBuilder extends FTheadCommentItem {
     static create(comment?: IThreadComment): FTheadCommentBuilder;
     /**
@@ -97,7 +104,7 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.newTheadComment()
-     *  .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
+     *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
      * ```
      */
     setContent(content: IDocumentBody | RichTextValue): FTheadCommentBuilder;
@@ -108,7 +115,7 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.newTheadComment()
-     *  .setPersonId('123');
+     *   .setPersonId('123');
      * ```
      */
     setPersonId(userId: string): FTheadCommentBuilder;
@@ -119,7 +126,7 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.newTheadComment()
-     *  .setDateTime(new Date());
+     *   .setDateTime(new Date());
      * ```
      */
     setDateTime(date: Date): FTheadCommentBuilder;
@@ -130,7 +137,7 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.newTheadComment()
-     *  .setId('123');
+     *   .setId('123');
      * ```
      */
     setId(id: string): FTheadCommentBuilder;
@@ -141,7 +148,7 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.newTheadComment()
-     *  .setThreadId('123');
+     *   .setThreadId('123');
      * ```
      */
     setThreadId(threadId: string): FTheadCommentBuilder;
@@ -151,12 +158,15 @@ export declare class FTheadCommentBuilder extends FTheadCommentItem {
      * @example
      * ```ts
      * const comment = univerAPI.newTheadComment()
-     *  .setContent(univerAPI.newRichText().insertText('hello zhangsan'))
-     *  .build();
+     *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'))
+     *   .build();
      * ```
      */
     build(): IThreadComment;
 }
+/**
+ * A class that represents a thread comment already in the sheet.
+ */
 export declare class FThreadComment {
     private readonly _thread;
     private readonly _parent;
@@ -165,52 +175,55 @@ export declare class FThreadComment {
     private readonly _univerInstanceService;
     private readonly _threadCommentModel;
     private readonly _userManagerService;
+    /**
+     * @ignore
+     */
     constructor(_thread: IThreadComment | IBaseComment, _parent: IThreadComment | undefined, _injector: Injector, _commandService: ICommandService, _univerInstanceService: IUniverInstanceService, _threadCommentModel: SheetsThreadCommentModel, _userManagerService: UserManagerService);
     private _getRef;
     /**
      * Whether the comment is a root comment
-     * @returns Whether the comment is a root comment
+     * @returns {boolean} Whether the comment is a root comment
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const isRoot = comment.getIsRoot();
      * ```
      */
     getIsRoot(): boolean;
     /**
      * Get the comment data
-     * @returns The comment data
+     * @returns {IBaseComment} The comment data
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const commentData = comment.getCommentData();
      * ```
      */
     getCommentData(): IBaseComment;
     /**
      * Get the replies of the comment
-     * @returns the replies of the comment
+     * @returns {FThreadComment[]} the replies of the comment
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const replies = comment.getReplies();
      * ```
      */
     getReplies(): FThreadComment[] | undefined;
     /**
      * Get the range of the comment
-     * @returns The range of the comment
+     * @returns {FRange | null} The range of the comment
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const range = comment.getRange();
      * ```
      */
@@ -225,8 +238,8 @@ export declare class FThreadComment {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const richText = comment.getRichText();
      * ```
      */
@@ -237,8 +250,8 @@ export declare class FThreadComment {
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const success = await comment.deleteAsync();
      * ```
      */
@@ -248,53 +261,51 @@ export declare class FThreadComment {
      */
     delete(): Promise<boolean>;
     /**
-     * @param content
      * @deprecated use `updateAsync` as instead
      */
     update(content: IDocumentBody): Promise<boolean>;
     /**
      * Update the comment content
-     * @param content The new content of the comment
-     * @returns success or not
+     * @param {IDocumentBody | RichTextValue} content The new content of the comment
+     * @returns {Promise<boolean>} success or not
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const success = await comment.updateAsync(univerAPI.newRichText().insertText('hello zhangsan'));
      * ```
      */
     updateAsync(content: IDocumentBody | RichTextValue): Promise<boolean>;
     /**
-     * @param resolved
      * @deprecated use `resolveAsync` as instead
      */
     resolve(resolved?: boolean): Promise<boolean>;
     /**
      * Resolve the comment
-     * @param resolved Whether the comment is resolved
-     * @returns success or not
+     * @param {boolean} resolved Whether the comment is resolved
+     * @returns {Promise<boolean>} success or not
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      * const success = await comment.resolveAsync(true);
      * ```
      */
     resolveAsync(resolved?: boolean): Promise<boolean>;
     /**
      * Reply to the comment
-     * @param comment The comment to reply to
-     * @returns success or not
+     * @param {FTheadCommentBuilder} comment The comment to reply to
+     * @returns {Promise<boolean>} success or not
      * @example
      * ```ts
      * const comment = univerAPI.getActiveWorkbook()
-     *  .getSheetById(sheetId)
-     *  .getCommentById(commentId);
+     *   .getSheetById(sheetId)
+     *   .getCommentById(commentId);
      *
      * const reply = univerAPI.newTheadComment()
-     *  .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
+     *   .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
      *
      * const success = await comment.replyAsync(reply);
      * ```

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

@@ -2,6 +2,9 @@ import { IDisposable, Injector, FUniver } from '@univerjs/core';
 import { IThreadComment } from '@univerjs/thread-comment';
 import { ISheetCommentAddEvent, ISheetCommentDeleteEvent, ISheetCommentResolveEvent, ISheetCommentUpdateEvent } from './f-event';
 import { FTheadCommentBuilder } from './f-thread-comment';
+/**
+ * @ignore
+ */
 export interface IFUniverCommentMixin {
     /**
      * @deprecated use `univerAPI.addEvent(univerAPI.event.CommentAdded, () => {})` as instead
@@ -29,9 +32,15 @@ export interface IFUniverCommentMixin {
      */
     newTheadComment(): FTheadCommentBuilder;
 }
+/**
+ * @ignore
+ */
 export declare class FUniverCommentMixin extends FUniver implements IFUniverCommentMixin {
     private _handleCommentCommand;
     private _handleBeforeCommentCommand;
+    /**
+     * @ignore
+     */
     _initialize(injector: Injector): void;
     newTheadComment(comment?: IThreadComment): FTheadCommentBuilder;
 }

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

@@ -3,6 +3,9 @@ import { CommentUpdate, IAddCommentCommandParams, IDeleteCommentCommandParams, T
 import { FWorkbook } from '@univerjs/sheets/facade';
 import { FThreadComment } from './f-thread-comment';
 type IUpdateCommandParams = any;
+/**
+ * @ignore
+ */
 export interface IFWorkbookThreadCommentMixin {
     /**
      * Get all comments in the current sheet
@@ -41,8 +44,14 @@ export interface IFWorkbookThreadCommentMixin {
      */
     onBeforeDeleteThreadComment(this: FWorkbook, callback: (params: IDeleteCommentCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable;
 }
+/**
+ * @ignore
+ */
 export declare class FWorkbookThreadCommentMixin extends FWorkbook implements IFWorkbookThreadCommentMixin {
     _threadCommentModel: ThreadCommentModel;
+    /**
+     * @ignore
+     */
     _initialize(): void;
     getComments(): FThreadComment[];
     clearComments(): Promise<boolean>;

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

@@ -2,6 +2,9 @@ import { IDisposable } from '@univerjs/core';
 import { IAddCommentCommandParams } from '@univerjs/thread-comment';
 import { FWorksheet } from '@univerjs/sheets/facade';
 import { FThreadComment } from './f-thread-comment';
+/**
+ * @ignore
+ */
 export interface IFWorksheetCommentMixin {
     /**
      * Get all comments in the current sheet
@@ -33,6 +36,9 @@ export interface IFWorksheetCommentMixin {
      */
     getCommentById(commentId: string): FThreadComment | undefined;
 }
+/**
+ * @ignore
+ */
 export declare class FWorksheetCommentMixin extends FWorksheet implements IFWorksheetCommentMixin {
     getComments(): FThreadComment[];
     clearComments(): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-thread-comment",
-  "version": "0.5.5",
+  "version": "0.6.0-experimental.20250125-1d060b9",
   "private": false,
   "description": "Univer sheets thread comment base plugin",
   "author": "DreamNum <developer@univer.ai>",
@@ -51,17 +51,17 @@
     "rxjs": ">=7.0.0"
   },
   "dependencies": {
-    "@univerjs/core": "0.5.5",
-    "@univerjs/sheets": "0.5.5",
-    "@univerjs/thread-comment": "0.5.5",
-    "@univerjs/engine-formula": "0.5.5"
+    "@univerjs/engine-formula": "0.6.0-experimental.20250125-1d060b9",
+    "@univerjs/core": "0.6.0-experimental.20250125-1d060b9",
+    "@univerjs/thread-comment": "0.6.0-experimental.20250125-1d060b9",
+    "@univerjs/sheets": "0.6.0-experimental.20250125-1d060b9"
   },
   "devDependencies": {
     "rxjs": "^7.8.1",
-    "typescript": "^5.7.2",
+    "typescript": "^5.7.3",
     "vite": "^6.0.7",
     "vitest": "^2.1.8",
-    "@univerjs-infra/shared": "0.5.5"
+    "@univerjs-infra/shared": "0.6.0-alpha.0"
   },
   "scripts": {
     "test": "vitest run",

package/LICENSE

@@ -1,176 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS