@univerjs/core 0.5.4 → 0.5.5-experimental.20250123-34738ff

package/lib/types/common/const.d.ts

@@ -18,5 +18,6 @@ export declare const DOCS_FORMULA_BAR_EDITOR_UNIT_ID_KEY = "__INTERNAL_EDITOR__D
 export declare const DOCS_ZEN_EDITOR_UNIT_ID_KEY = "__INTERNAL_EDITOR__ZEN_EDITOR";
 export declare const DEFAULT_EMPTY_DOCUMENT_VALUE = "\r\n";
 export declare const IS_ROW_STYLE_PRECEDE_COLUMN_STYLE = "isRowStylePrecedeColumnStyle";
+export declare const AUTO_HEIGHT_FOR_MERGED_CELLS: unique symbol;
 export declare function createInternalEditorID(id: string): string;
 export declare function isInternalEditorID(id: string): boolean;

package/lib/types/docs/data-model/document-data-model.d.ts

@@ -1,10 +1,10 @@
-import { BehaviorSubject } from 'rxjs';
-import { UnitModel, UniverInstanceType } from '../../common/unit';
-import { SliceBodyType } from './text-x/utils';
 import { Nullable } from '../../shared';
 import { IDocumentBody, IDocumentData, IDocumentRenderConfig, IDocumentStyle, IDrawings, IListData } from '../../types/interfaces/i-document-data';
 import { IPaddingData } from '../../types/interfaces/i-style-data';
 import { JSONXActions } from './json-x/json-x';
+import { BehaviorSubject } from 'rxjs';
+import { UnitModel, UniverInstanceType } from '../../common/unit';
+import { SliceBodyType } from './text-x/utils';
 export declare const DEFAULT_DOC: {
     id: string;
     documentStyle: {};
@@ -46,6 +46,7 @@ export declare class DocumentDataModel extends DocumentDataModelSimple {
     private _unitId;
     headerModelMap: Map<string, DocumentDataModel>;
     footerModelMap: Map<string, DocumentDataModel>;
+    change$: BehaviorSubject<number>;
     constructor(snapshot: Partial<IDocumentData>);
     dispose(): void;
     getDrawings(): IDrawings | undefined;

package/lib/types/docs/data-model/rich-text-builder.d.ts

@@ -1,6 +1,8 @@
 import { Nullable } from '../../shared';
 import { BaselineOffset, HorizontalAlign, TextDecoration, TextDirection, BooleanNumber } from '../../types/enum';
 import { IBorderData, IColorStyle, IDocumentBody, IDocumentData, INumberUnit, IParagraphBorder, IParagraphStyle, IShading, ITabStop, ITextDecoration, ITextStyle, NamedStyleType, SpacingRule } from '../../types/interfaces';
+export declare function normalizeBody(body: IDocumentBody): IDocumentBody;
+export declare function normalizeData(data: IDocumentData): IDocumentData;
 /**
  * Represents a read-only font style value object.
  * This class provides access to font style properties without modification capabilities.
@@ -1084,18 +1086,31 @@ export declare class RichTextValue {
      * Creates a new RichTextValue instance
      * @param {IDocumentData} data The initial data for the rich text value
      * @returns {RichTextValue} A new RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * ```
      */
     static create(data: IDocumentData): RichTextValue;
     /**
      * Creates a new RichTextValue instance
      * @param {IDocumentBody} data The initial data for the rich text value
      * @returns {RichTextValue} A new RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.createByBody({ dataStream: 'Hello World\r\n' });
+     * ```
      */
     static createByBody(data: IDocumentBody): RichTextValue;
     constructor(data: IDocumentData);
     /**
      * Creates a copy of the current RichTextValue instance
      * @returns {RichTextValue} A new instance of RichTextValue with the same data
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const copy = richText.copy();
+     * ```
      */
     copy(): RichTextBuilder;
     /**
@@ -1103,31 +1118,61 @@ export declare class RichTextValue {
      * @param {number} start The start index
      * @param {number} end The end index
      * @returns {RichTextBuilder} A new instance of RichTextBuilder with the sliced data
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const sliced = richText.slice(0, 5);
+     * ```
      */
     slice(start: number, end: number): RichTextBuilder;
     /**
      * Converts the current RichTextValue instance to plain text
      * @returns {string} The plain text representation of the current RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const plainText = richText.toPlainText();
+     * ```
      */
     toPlainText(): string;
     /**
      * Gets the paragraph style of the current RichTextValue instance
      * @returns {ParagraphStyleValue} The paragraph style of the current RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const style = richText.getParagraphStyle();
+     * ```
      */
     getParagraphStyle(): ParagraphStyleValue;
     /**
      * Gets the paragraph bullet of the current RichTextValue instance
      * @returns {ParagraphBulletValue} The paragraph bullet of the current RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const bullet = richText.getParagraphBullet();
+     * ```
      */
     getParagraphBullet(): import('../..').IBullet | undefined;
     /**
      * Gets the paragraphs of the current RichTextValue instance
      * @returns {RichTextValue[]} The paragraphs of the current RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const paragraphs = richText.getParagraphs();
+     * ```
      */
     getParagraphs(): RichTextValue[];
     /**
      * Gets the text runs of the current RichTextValue instance
      * @returns {TextRunValue[]} The text runs of the current RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const textRuns = richText.getTextRuns();
+     * ```
      */
     getTextRuns(): {
         ts: TextStyleValue | null;
@@ -1137,12 +1182,22 @@ export declare class RichTextValue {
     }[];
     /**
      * Gets the links of the current RichTextValue instance
-     * @returns {LinkValue[]} The links of the current RichTextValue instance
+     * @returns {ICustomRange[]} The links of the current RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const links = richText.getLinks();
+     * ```
      */
     getLinks(): import('../..').ICustomRange<Record<string, any>>[];
     /**
      * Gets the data of the current RichTextValue instance
      * @returns {IDocumentData} The data of the current RichTextValue instance
+     * @example
+     * ```ts
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
+     * const data = richText.getData();
+     * ```
      */
     getData(): IDocumentData;
 }
@@ -1167,7 +1222,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.insertText(0, 'World');
      * ```
      */
@@ -1180,7 +1235,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.insertText(5, 'World', { ff: 'Arial', fs: 12 });
      * ```
      */
@@ -1191,7 +1246,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextValue | IDocumentData} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.insertRichText(RichTextValue.create({ body: { dataStream: 'World' } }));
      * ```
      */
@@ -1203,7 +1258,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextValue | IDocumentData} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.insertRichText(5, RichTextValue.create({ body: { dataStream: 'World' } }));
      * ```
      */
@@ -1214,7 +1269,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.delete(5);
      * ```
      */
@@ -1226,7 +1281,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.delete(5, 5);
      * ```
      */
@@ -1239,7 +1294,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.setStyle(5, 10, { ff: 'Arial', fs: 12 });
      * ```
      */
@@ -1252,7 +1307,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.setLink(5, 10, 'https://www.example.com');
      * ```
      */
@@ -1265,7 +1320,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * ```ts
      * const richText = RichTextValue.create({
      *      body: {
-     *          dataStream: 'Hello World',
+     *          dataStream: 'Hello World\r\n',
      *          customRanges: [
      *              {
      *                  rangeType: CustomRangeType.HYPERLINK,
@@ -1289,7 +1344,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * ```ts
      * const richText = RichTextValue.create({
      *      body: {
-     *          dataStream: 'Hello World',
+     *          dataStream: 'Hello World\r\n',
      *          customRanges: [
      *              {
      *                  rangeType: CustomRangeType.HYPERLINK,
@@ -1312,7 +1367,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.insertParagraph();
      * ```
      */
@@ -1324,7 +1379,7 @@ export declare class RichTextBuilder extends RichTextValue {
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example
      * ```ts
-     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World' } });
+     * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
      * const newRichText = richText.insertParagraph(5, { ff: 'Arial', fs: 12 });
      * ```
      */

package/lib/types/docs/data-model/text-x/build-utils/index.d.ts

@@ -19,6 +19,7 @@ export declare class BuildTextUtils {
         makeSelection: typeof makeSelection;
         normalizeSelection: typeof normalizeSelection;
         delete: typeof deleteSelectionTextX;
+        replaceTextRuns: (params: import('./text-x-utils').IReplaceSelectionTextXParams) => false | import('../text-x').TextX;
         retain: typeof retainSelectionTextX;
     };
     static range: {

package/lib/types/docs/data-model/text-x/build-utils/text-x-utils.d.ts

@@ -38,3 +38,4 @@ export interface IReplaceSelectionTextXParams {
     doc: DocumentDataModel;
 }
 export declare const replaceSelectionTextX: (params: IReplaceSelectionTextXParams) => false | TextX;
+export declare const replaceSelectionTextRuns: (params: IReplaceSelectionTextXParams) => false | TextX;

package/lib/types/docs/data-model/text-x/utils.d.ts

@@ -1,10 +1,57 @@
-import { ICustomDecoration, IDocumentBody } from '../../../types/interfaces/i-document-data';
+import { ICustomDecoration, IDocumentBody, ITextRun } from '../../../types/interfaces/i-document-data';
 import { IRetainAction } from './action-types';
 import { UpdateDocsAttributeType } from '../../../shared/command-enum';
 export declare enum SliceBodyType {
     copy = 0,
     cut = 1
 }
+export declare function getTextRunSlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyTextRuns?: boolean): ITextRun[] | undefined;
+export declare function getTableSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
+    startIndex: number;
+    endIndex: number;
+    tableId: string;
+}[];
+export declare function getParagraphsSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
+    startIndex: number;
+    paragraphStyle?: import('../../..').IParagraphStyle;
+    bullet?: import('../../..').IBullet;
+}[] | undefined;
+export declare function getSectionBreakSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
+    startIndex: number;
+    pageNumberStart?: number;
+    pageSize?: import('../../..').ISize;
+    pageOrient?: import('../../..').PageOrientType;
+    documentFlavor?: import('../../..').DocumentFlavor;
+    marginHeader?: number;
+    marginFooter?: number;
+    renderConfig?: import('../../..').IDocumentRenderConfig;
+    marginTop?: number;
+    marginBottom?: number;
+    marginRight?: number;
+    marginLeft?: number;
+    charSpace?: number;
+    linePitch?: number;
+    gridType?: import('../../..').GridType;
+    columnProperties?: import('../../..').ISectionColumnProperties[];
+    columnSeparatorType?: import('../../..').ColumnSeparatorType;
+    contentDirection?: import('../../..').TextDirection;
+    sectionType?: import('../../..').SectionType;
+    sectionTypeNext?: import('../../..').SectionType;
+    textDirection?: import('../../..').TextDirectionType;
+    defaultHeaderId?: string;
+    defaultFooterId?: string;
+    evenPageHeaderId?: string;
+    evenPageFooterId?: string;
+    firstPageHeaderId?: string;
+    firstPageFooterId?: string;
+    useFirstPageHeaderFooter?: import('../../..').BooleanNumber;
+    evenAndOddHeaders?: import('../../..').BooleanNumber;
+}[] | undefined;
+export declare function getCustomBlockSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
+    startIndex: number;
+    blockType?: import('../../..').BlockType;
+    blockId: string;
+}[] | undefined;
 export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyArray?: boolean, type?: SliceBodyType): IDocumentBody;
 export declare function normalizeBody(body: IDocumentBody): IDocumentBody;
 export declare function getCustomRangeSlice(body: IDocumentBody, startOffset: number, endOffset: number): {

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

@@ -4,16 +4,33 @@ import { Disposable } from '../shared';
  * `FBase` is a base class for all facade classes.
  * It provides a way to extend classes with static and instance methods.
  * The `_initialize` as a special method that will be called after the constructor. You should never call it directly.
+ * @ignore
  */
 export declare abstract class FBase extends Disposable {
+    /**
+     * @ignore
+     */
     static extend(source: any): void;
 }
+/**
+ * @ignore
+ */
 declare const InitializerSymbol: unique symbol;
+/**
+ * @ignore
+ * @hideconstructor
+ */
 export declare class FBaseInitialable extends Disposable {
     protected _injector: Injector;
     private [InitializerSymbol];
     constructor(_injector: Injector);
+    /**
+     * @ignore
+     */
     _initialize(injector: Injector): void;
+    /**
+     * @ignore
+     */
     static extend(source: any): void;
 }
 export {};

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

@@ -12,6 +12,9 @@ export interface IFBlobSource {
      */
     getAs(contentType: string): FBlob;
 }
+/**
+ * @hideconstructor
+ */
 export declare class FBlob extends FBase {
     private _blob;
     protected readonly _injector: Injector;

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

@@ -1,6 +1,10 @@
 import { DocumentDataModel } from '../docs';
 import { Injector } from '../common/di';
 import { FBaseInitialable } from './f-base';
+/**
+ * @ignore
+ * @hideconstructor
+ */
 export declare class FDoc extends FBaseInitialable {
     protected doc: DocumentDataModel;
     constructor(doc: DocumentDataModel, _injector: Injector);

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

@@ -1,15 +1,39 @@
 import { UniverInstanceType } from '../common/unit';
 import { CommandType } from '../services/command/command.service';
 import { LifecycleStages } from '../services/lifecycle/lifecycle';
-import { BaselineOffset, BooleanNumber, HorizontalAlign, TextDecoration, TextDirection, VerticalAlign } from '../types/enum';
+import { BaselineOffset, BooleanNumber, BorderStyleTypes, BorderType, HorizontalAlign, TextDecoration, TextDirection, VerticalAlign } from '../types/enum';
+import { AutoFillSeries } from '../types/enum/auto-fill-series';
+import { ColorType } from '../types/enum/color-type';
+import { CommonHideTypes } from '../types/enum/common-hide-types';
+import { CopyPasteType } from '../types/enum/copy-paste-type';
 import { DataValidationErrorStyle } from '../types/enum/data-validation-error-style';
 import { DataValidationOperator } from '../types/enum/data-validation-operator';
 import { DataValidationRenderMode } from '../types/enum/data-validation-render-mode';
 import { DataValidationStatus } from '../types/enum/data-validation-status';
 import { DataValidationType } from '../types/enum/data-validation-type';
+import { DeleteDirection } from '../types/enum/delete-direction';
+import { DeveloperMetadataVisibility } from '../types/enum/developer-metadata-visibility';
+import { Dimension } from '../types/enum/dimension';
+import { Direction } from '../types/enum/direction';
+import { InterpolationPointType } from '../types/enum/interpolation-point-type';
+import { LocaleType } from '../types/enum/locale-type';
+import { MentionType } from '../types/enum/mention-type';
+import { ProtectionType } from '../types/enum/protection-type';
+import { RelativeDate } from '../types/enum/relative-date';
+import { SheetTypes } from '../types/enum/sheet-types';
+import { ThemeColorType } from '../types/enum/theme-color-type';
+/**
+ * @hideconstructor
+ */
 export declare class FEnum {
+    /**
+     * @ignore
+     */
     static _instance: FEnum | null;
     static get(): FEnum;
+    /**
+     * @ignore
+     */
     static extend(source: any): void;
     constructor();
     /**
@@ -68,4 +92,72 @@ export declare class FEnum {
      * Different vertical text alignment options
      */
     get VerticalAlign(): typeof VerticalAlign;
+    /**
+     * Different border types
+     */
+    get BorderType(): typeof BorderType;
+    /**
+     * Different border style types
+     */
+    get BorderStyleTypes(): typeof BorderStyleTypes;
+    /**
+     * Auto fill series types
+     */
+    get AutoFillSeries(): typeof AutoFillSeries;
+    /**
+     * Color types
+     */
+    get ColorType(): typeof ColorType;
+    /**
+     * Common hide types
+     */
+    get CommonHideTypes(): typeof CommonHideTypes;
+    /**
+     * Copy paste types
+     */
+    get CopyPasteType(): typeof CopyPasteType;
+    /**
+     * Delete direction types
+     */
+    get DeleteDirection(): typeof DeleteDirection;
+    /**
+     * Developer metadata visibility types
+     */
+    get DeveloperMetadataVisibility(): typeof DeveloperMetadataVisibility;
+    /**
+     * Dimension types
+     */
+    get Dimension(): typeof Dimension;
+    /**
+     * Direction types
+     */
+    get Direction(): typeof Direction;
+    /**
+     * Interpolation point types
+     */
+    get InterpolationPointType(): typeof InterpolationPointType;
+    /**
+     * Locale types
+     */
+    get LocaleType(): typeof LocaleType;
+    /**
+     * Mention types
+     */
+    get MentionType(): typeof MentionType;
+    /**
+     * Protection types
+     */
+    get ProtectionType(): typeof ProtectionType;
+    /**
+     * Relative date types
+     */
+    get RelativeDate(): typeof RelativeDate;
+    /**
+     * Sheet types
+     */
+    get SheetTypes(): typeof SheetTypes;
+    /**
+     * Theme color types
+     */
+    get ThemeColorType(): typeof ThemeColorType;
 }

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

@@ -6,6 +6,7 @@ import { FDoc } from './f-doc';
 /**
  * Base interface for all event parameters
  * @interface IEventBase
+ * @ignore
  */
 export interface IEventBase {
     /** Flag to cancel the event if supported */
@@ -61,9 +62,18 @@ export interface ICommandEvent extends IEventBase {
     /** Type of the command */
     type: CommandType;
 }
+/**
+ * @hideconstructor
+ */
 export declare class FEventName {
+    /**
+     * @ignore
+     */
     static _instance: FEventName | null;
     static get(): FEventName;
+    /**
+     * @ignore
+     */
     static extend(source: any): void;
     constructor();
     /**
@@ -72,8 +82,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.DocCreated, (params) => {
-     *     const { unitId, type, doc, unit } = params;
-     *     console.log('doc created', params);
+     *   const { unitId, type, doc, unit } = params;
+     *   console.log('doc created', params);
      * });
      * ```
      */
@@ -84,8 +94,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.DocDisposed, (params) => {
-     *     const { unitId, unitType, snapshot } = params;
-     *     console.log('doc disposed', params);
+     *   const { unitId, unitType, snapshot } = params;
+     *   console.log('doc disposed', params);
      * });
      * ```
      */
@@ -96,8 +106,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.LifeCycleChanged, (params) => {
-     *      const { stage } = params;
-     *     console.log('life cycle changed', params);
+     *   const { stage } = params;
+     *   console.log('life cycle changed', params);
      * });
      * ```
      */
@@ -108,8 +118,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.Redo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -120,8 +130,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.Undo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -132,8 +142,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.BeforeRedo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -144,8 +154,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.BeforeUndo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -156,8 +166,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.CommandExecuted, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -168,8 +178,8 @@ export declare class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.BeforeCommandExecute, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */