@univerjs/core 0.6.0 → 0.6.1

package/lib/es/facade.js

@@ -1,7 +1,7 @@
 var A = Object.defineProperty;
 var L = (i, e, t) => e in i ? A(i, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : i[e] = t;
 var d = (i, e, t) => L(i, typeof e != "symbol" ? e + "" : e, t);
-import { Disposable as V, Inject as l, Injector as _, UniverInstanceType as T, LifecycleStages as f, DataValidationType as F, DataValidationErrorStyle as q, DataValidationRenderMode as G, DataValidationOperator as J, DataValidationStatus as K, CommandType as Q, BaselineOffset as W, BooleanNumber as X, HorizontalAlign as Y, TextDecoration as Z, TextDirection as k, VerticalAlign as ee, BorderType as te, BorderStyleTypes as re, AutoFillSeries as ie, ColorType as ne, CommonHideTypes as oe, CopyPasteType as se, DeleteDirection as ce, DeveloperMetadataVisibility as ae, Dimension as de, Direction as pe, InterpolationPointType as le, LocaleType as he, MentionType as ue, ProtectionType as ye, RelativeDate as ge, SheetTypes as ve, ThemeColorType as fe, LifecycleService as I, toDisposable as p, ICommandService as y, UndoCommand as h, IUndoRedoService as m, RedoCommand as u, Registry as _e, UserManagerService as me, Rectangle as Ee, numfmt as be, Tools as Se, IUniverInstanceService as N, Univer as Ce, CanceledError as D, ColorBuilder as De, RichTextBuilder as xe, RichTextValue as we, ParagraphStyleBuilder as Te, ParagraphStyleValue as Re, TextStyleBuilder as Oe, TextStyleValue as Pe, TextDecorationBuilder as je } from "@univerjs/core";
+import { Disposable as V, Inject as l, Injector as _, UniverInstanceType as T, LifecycleStages as f, DataValidationType as F, DataValidationErrorStyle as W, DataValidationRenderMode as q, DataValidationOperator as G, DataValidationStatus as J, CommandType as K, BaselineOffset as Q, BooleanNumber as X, HorizontalAlign as Y, TextDecoration as Z, TextDirection as k, VerticalAlign as ee, WrapStrategy as te, BorderType as re, BorderStyleTypes as ie, AutoFillSeries as ne, ColorType as oe, CommonHideTypes as se, CopyPasteType as ce, DeleteDirection as ae, DeveloperMetadataVisibility as de, Dimension as pe, Direction as le, InterpolationPointType as he, LocaleType as ue, MentionType as ye, ProtectionType as ge, RelativeDate as ve, SheetTypes as fe, ThemeColorType as _e, LifecycleService as I, toDisposable as p, ICommandService as y, UndoCommand as h, IUndoRedoService as m, RedoCommand as u, Registry as me, UserManagerService as Ee, Rectangle as be, numfmt as Se, Tools as Ce, IUniverInstanceService as N, Univer as De, CanceledError as D, ColorBuilder as xe, RichTextBuilder as we, RichTextValue as Te, ParagraphStyleBuilder as Re, ParagraphStyleValue as Oe, TextStyleBuilder as Pe, TextStyleValue as je, TextDecorationBuilder as Be } from "@univerjs/core";
 import { filter as E } from "rxjs";
 class $ extends V {
   /**
@@ -16,7 +16,7 @@ class $ extends V {
   }
 }
 const x = Symbol("initializers");
-class Be extends V {
+class He extends V {
   constructor(e) {
     super(), this._injector = e;
     const t = this, r = Object.getPrototypeOf(this)[x];
@@ -43,11 +43,11 @@ class Be extends V {
     });
   }
 }
-var He = Object.getOwnPropertyDescriptor, Ue = (i, e, t, r) => {
-  for (var n = r > 1 ? void 0 : r ? He(e, t) : e, o = i.length - 1, s; o >= 0; o--)
+var Ue = Object.getOwnPropertyDescriptor, Ve = (i, e, t, r) => {
+  for (var n = r > 1 ? void 0 : r ? Ue(e, t) : e, o = i.length - 1, s; o >= 0; o--)
     (s = i[o]) && (n = s(n) || n);
   return n;
-}, Ve = (i, e) => (t, r) => e(t, r, i);
+}, Ie = (i, e) => (t, r) => e(t, r, i);
 let S = class extends $ {
   constructor(i, e) {
     super(), this._blob = i, this._injector = e;
@@ -57,7 +57,7 @@ let S = class extends $ {
    * @returns a new blob by copying the current blob
    * @example
    * ```ts
-   * const blob = univerAPI.newBlob(blob);
+   * const blob = univerAPI.newBlob();
    * const newBlob = blob.copyBlob();
    * console.log(newBlob);
    * ```
@@ -71,8 +71,9 @@ let S = class extends $ {
    * @returns a new blob by converting the current blob to the specified content type
    * @example
    * ```ts
-   * const blob = univerAPI.newBlob(blob);
-   * const newBlob = blob.getBlob();
+   * const blob = univerAPI.newBlob();
+   * const newBlob = blob.getAs('text/plain');
+   * console.log(newBlob);
    * ```
    */
   getAs(i) {
@@ -94,9 +95,9 @@ let S = class extends $ {
    * @returns the blob content as a byte array
    * @example
    * ```ts
-   * const blob = univerAPI.newBlob(blob);
-   * const newBlob = blob.getBytes();
-   * console.log(newBlob);
+   * const blob = univerAPI.newBlob();
+   * const bytes = await blob.getBytes();
+   * console.log(bytes);
    * ```
    */
   getBytes() {
@@ -125,9 +126,9 @@ let S = class extends $ {
    * @returns the content type
    * @example
    * ```ts
-   * const blob = univerAPI.newBlob(blob);
-   * const newBlob = blob.getContentType();
-   * console.log(newBlob);
+   * const blob = univerAPI.newBlob();
+   * const contentType = blob.getContentType();
+   * console.log(contentType);
    * ```
    */
   getContentType() {
@@ -140,9 +141,8 @@ let S = class extends $ {
    * @returns the blob object
    * @example
    * ```ts
-   * const blob = univerAPI.newBlob(blob);
-   * const newBlob = blob.setContentType('text/plain');
-   * console.log(newBlob);
+   * const blob = univerAPI.newBlob();
+   * blob.setContentType('text/plain');
    * ```
    */
   setContentType(i) {
@@ -150,8 +150,8 @@ let S = class extends $ {
     return this._blob = (e = this._blob) == null ? void 0 : e.slice(0, this._blob.size, i), this;
   }
 };
-S = Ue([
-  Ve(1, l(_))
+S = Ve([
+  Ie(1, l(_))
 ], S);
 const g = class g {
   static get() {
@@ -175,190 +175,356 @@ const g = class g {
       this[e] = g.prototype[e];
   }
   /**
-   *  Defines different types of Univer instances
+   * Defines different types of Univer instances
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.UniverInstanceType.UNIVER_SHEET);
+   * ```
    */
   get UniverInstanceType() {
     return T;
   }
   /**
    * Represents different stages in the lifecycle
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.LifecycleStages.Rendered);
+   * ```
    */
   get LifecycleStages() {
     return f;
   }
   /**
    * Different types of data validation
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.DataValidationType.LIST);
+   * ```
    */
   get DataValidationType() {
     return F;
   }
   /**
    * Different error display styles
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.DataValidationErrorStyle.WARNING);
+   * ```
    */
   get DataValidationErrorStyle() {
-    return q;
+    return W;
   }
   /**
    * Different validation rendering modes
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.DataValidationRenderMode.TEXT);
+   * ```
    */
   get DataValidationRenderMode() {
-    return G;
+    return q;
   }
   /**
    * Different validation operators
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.DataValidationOperator.BETWEEN);
+   * ```
    */
   get DataValidationOperator() {
-    return J;
+    return G;
   }
   /**
    * Different validation states
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.DataValidationStatus.VALID);
+   * ```
    */
   get DataValidationStatus() {
-    return K;
+    return J;
   }
   /**
    * Different types of commands
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.CommandType.COMMAND);
+   * ```
    */
   get CommandType() {
-    return Q;
+    return K;
   }
   /**
    * Different baseline offsets for text baseline positioning
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.BaselineOffset.SUPERSCRIPT);
+   * ```
    */
   get BaselineOffset() {
-    return W;
+    return Q;
   }
   /**
    * Boolean number representations
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.BooleanNumber.TRUE);
+   * ```
    */
   get BooleanNumber() {
     return X;
   }
   /**
    * Different horizontal text alignment options
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.HorizontalAlign.CENTER);
+   * ```
    */
   get HorizontalAlign() {
     return Y;
   }
   /**
    * Different text decoration styles
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.TextDecoration.DOUBLE);
+   * ```
    */
   get TextDecoration() {
     return Z;
   }
   /**
    * Different text direction options
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.TextDirection.LEFT_TO_RIGHT);
+   * ```
    */
   get TextDirection() {
     return k;
   }
   /**
    * Different vertical text alignment options
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.VerticalAlign.MIDDLE);
+   * ```
    */
   get VerticalAlign() {
     return ee;
   }
+  /**
+   * Different wrap strategy options
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.WrapStrategy.WRAP);
+   * ```
+   */
+  get WrapStrategy() {
+    return te;
+  }
   /**
    * Different border types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.BorderType.OUTSIDE);
+   * ```
    */
   get BorderType() {
-    return te;
+    return re;
   }
   /**
    * Different border style types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.BorderStyleTypes.NONE);
+   * ```
    */
   get BorderStyleTypes() {
-    return re;
+    return ie;
   }
   /**
    * Auto fill series types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.AutoFillSeries.ALTERNATE_SERIES);
+   * ```
    */
   get AutoFillSeries() {
-    return ie;
+    return ne;
   }
   /**
    * Color types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.ColorType.RGB);
+   * ```
    */
   get ColorType() {
-    return ne;
+    return oe;
   }
   /**
    * Common hide types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.CommonHideTypes.ON);
+   * ```
    */
   get CommonHideTypes() {
-    return oe;
+    return se;
   }
   /**
    * Copy paste types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.CopyPasteType.PASTE_VALUES);
+   * ```
    */
   get CopyPasteType() {
-    return se;
+    return ce;
   }
   /**
    * Delete direction types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.DeleteDirection.LEFT);
+   * ```
    */
   get DeleteDirection() {
-    return ce;
+    return ae;
   }
   /**
    * Developer metadata visibility types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.DeveloperMetadataVisibility.DOCUMENT);
+   * ```
    */
   get DeveloperMetadataVisibility() {
-    return ae;
+    return de;
   }
   /**
    * Dimension types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.Dimension.ROWS);
+   * ```
    */
   get Dimension() {
-    return de;
+    return pe;
   }
   /**
    * Direction types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.Direction.UP);
+   * ```
    */
   get Direction() {
-    return pe;
+    return le;
   }
   /**
    * Interpolation point types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.InterpolationPointType.NUMBER);
+   * ```
    */
   get InterpolationPointType() {
-    return le;
+    return he;
   }
   /**
    * Locale types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.LocaleType.EN_US);
+   * ```
    */
   get LocaleType() {
-    return he;
+    return ue;
   }
   /**
    * Mention types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.MentionType.PERSON);
+   * ```
    */
   get MentionType() {
-    return ue;
+    return ye;
   }
   /**
    * Protection types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.ProtectionType.RANGE);
+   * ```
    */
   get ProtectionType() {
-    return ye;
+    return ge;
   }
   /**
    * Relative date types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.RelativeDate.TODAY);
+   * ```
    */
   get RelativeDate() {
-    return ge;
+    return ve;
   }
   /**
    * Sheet types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.SheetTypes.GRID);
+   * ```
    */
   get SheetTypes() {
-    return ve;
+    return fe;
   }
   /**
    * Theme color types
+   *
+   * @example
+   * ```ts
+   * console.log(univerAPI.Enum.ThemeColorType.ACCENT1);
+   * ```
    */
   get ThemeColorType() {
-    return fe;
+    return _e;
   }
 };
 /**
@@ -392,10 +558,12 @@ const v = class v {
    * @see {@link IDocCreatedParam}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.DocCreated, (params) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.DocCreated, (params) => {
    *   const { unitId, type, doc, unit } = params;
    *   console.log('doc created', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get DocCreated() {
@@ -406,10 +574,12 @@ const v = class v {
    * @see {@link IDocDisposedEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.DocDisposed, (params) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.DocDisposed, (params) => {
    *   const { unitId, unitType, snapshot } = params;
    *   console.log('doc disposed', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get DocDisposed() {
@@ -420,10 +590,12 @@ const v = class v {
    * @see {@link ILifeCycleChangedEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.LifeCycleChanged, (params) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
    *   const { stage } = params;
    *   console.log('life cycle changed', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get LifeCycleChanged() {
@@ -434,10 +606,12 @@ const v = class v {
    * @see {@link ICommandEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.Redo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.Redo, (event) => {
    *   const { params, id, type } = event;
-   *   console.log('command executed', event);
+   *   console.log('redo command executed', event);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get Redo() {
@@ -448,10 +622,12 @@ const v = class v {
    * @see {@link ICommandEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.Undo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.Undo, (event) => {
    *   const { params, id, type } = event;
-   *   console.log('command executed', event);
+   *   console.log('undo command executed', event);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get Undo() {
@@ -462,10 +638,15 @@ const v = class v {
    * @see {@link ICommandEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.BeforeRedo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {
    *   const { params, id, type } = event;
-   *   console.log('command executed', event);
+   *   console.log('before redo command executed', event);
+   *
+   *   // Cancel the redo operation
+   *   event.cancel = true;
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get BeforeRedo() {
@@ -476,10 +657,15 @@ const v = class v {
    * @see {@link ICommandEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.BeforeUndo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {
    *   const { params, id, type } = event;
-   *   console.log('command executed', event);
+   *   console.log('before undo command executed', event);
+   *
+   *   // Cancel the undo operation
+   *   event.cancel = true;
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get BeforeUndo() {
@@ -490,10 +676,12 @@ const v = class v {
    * @see {@link ICommandEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.CommandExecuted, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {
    *   const { params, id, type } = event;
    *   console.log('command executed', event);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get CommandExecuted() {
@@ -504,10 +692,15 @@ const v = class v {
    * @see {@link ICommandEvent}
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.BeforeCommandExecute, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {
    *   const { params, id, type } = event;
-   *   console.log('command executed', event);
+   *   console.log('before command executed', event);
+   *
+   *   // Cancel the command execution
+   *   event.cancel = true;
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   get BeforeCommandExecute() {
@@ -519,8 +712,8 @@ const v = class v {
  */
 d(v, "_instance");
 let O = v;
-var Ie = Object.getOwnPropertyDescriptor, $e = (i, e, t, r) => {
-  for (var n = r > 1 ? void 0 : r ? Ie(e, t) : e, o = i.length - 1, s; o >= 0; o--)
+var $e = Object.getOwnPropertyDescriptor, Me = (i, e, t, r) => {
+  for (var n = r > 1 ? void 0 : r ? $e(e, t) : e, o = i.length - 1, s; o >= 0; o--)
     (s = i[o]) && (n = s(n) || n);
   return n;
 }, M = (i, e) => (t, r) => e(t, r, i);
@@ -530,35 +723,35 @@ let P = class extends $ {
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged)` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
    */
   onStarting(i) {
     return p(this._lifecycleService.lifecycle$.pipe(E((e) => e === f.Starting)).subscribe(i));
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged)` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
    */
   onReady(i) {
     return p(this._lifecycleService.lifecycle$.pipe(E((e) => e === f.Ready)).subscribe(i));
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged, () => {})` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
    */
   onRendered(i) {
     return p(this._lifecycleService.lifecycle$.pipe(E((e) => e === f.Rendered)).subscribe(i));
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged, () => {})` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
    */
   onSteady(i) {
     return p(this._lifecycleService.lifecycle$.pipe(E((e) => e === f.Steady)).subscribe(i));
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeUndo, () => {})` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {})` as instead
    */
   onBeforeUndo(i) {
     return this._injector.get(y).beforeCommandExecuted((t) => {
@@ -570,7 +763,7 @@ let P = class extends $ {
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.Undo, () => {})` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.Undo, (event) => {})` as instead
    */
   onUndo(i) {
     return this._injector.get(y).onCommandExecuted((t) => {
@@ -582,7 +775,7 @@ let P = class extends $ {
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeRedo, () => {})` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {})` as instead
    */
   onBeforeRedo(i) {
     return this._injector.get(y).beforeCommandExecuted((t) => {
@@ -594,7 +787,7 @@ let P = class extends $ {
   }
   /**
    * @param callback
-   * @deprecated use `univerAPI.addEvent(univerAPI.Event.Redo, () => {})` as instead
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.Redo, (event) => {})` as instead
    */
   onRedo(i) {
     return this._injector.get(y).onCommandExecuted((t) => {
@@ -605,31 +798,31 @@ let P = class extends $ {
     });
   }
 };
-P = $e([
+P = Me([
   M(0, l(_)),
   M(1, l(I))
 ], P);
-var Me = Object.getOwnPropertyDescriptor, ze = (i, e, t, r) => {
-  for (var n = r > 1 ? void 0 : r ? Me(e, t) : e, o = i.length - 1, s; o >= 0; o--)
+var ze = Object.getOwnPropertyDescriptor, Ne = (i, e, t, r) => {
+  for (var n = r > 1 ? void 0 : r ? ze(e, t) : e, o = i.length - 1, s; o >= 0; o--)
     (s = i[o]) && (n = s(n) || n);
   return n;
-}, Ne = (i, e) => (t, r) => e(t, r, i);
-let j = class extends Be {
+}, Ae = (i, e) => (t, r) => e(t, r, i);
+let j = class extends He {
   constructor(i, e) {
     super(e), this.doc = i;
   }
 };
-j = ze([
-  Ne(1, l(_))
+j = Ne([
+  Ae(1, l(_))
 ], j);
-class Ae {
+class Le {
   constructor() {
     d(this, "_eventRegistry", /* @__PURE__ */ new Map());
     d(this, "_eventHandlerMap", /* @__PURE__ */ new Map());
     d(this, "_eventHandlerRegisted", /* @__PURE__ */ new Map());
   }
   _ensureEventRegistry(e) {
-    return this._eventRegistry.has(e) || this._eventRegistry.set(e, new _e()), this._eventRegistry.get(e);
+    return this._eventRegistry.has(e) || this._eventRegistry.set(e, new me()), this._eventRegistry.get(e);
   }
   registerEventHandler(e, t) {
     const r = this._eventHandlerMap.get(e);
@@ -659,8 +852,9 @@ class Ae {
    * @returns {Disposable} The Disposable instance, for remove the listener
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.UnitCreated, (params) => {
-   *   console.log('unit created', params);
+   * univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
+   *   const { stage } = params;
+   *   console.log('life cycle changed', params);
    * });
    * ```
    */
@@ -674,7 +868,7 @@ class Ae {
    * @returns {boolean} should cancel
    * @example
    * ```ts
-   * this.fireEvent(univerAPI.event.UnitCreated, params);
+   * this.fireEvent(univerAPI.Event.LifeCycleChanged, params);
    * ```
    */
   fireEvent(e, t) {
@@ -684,8 +878,8 @@ class Ae {
     }), t.cancel;
   }
 }
-var Le = Object.getOwnPropertyDescriptor, Fe = (i, e, t, r) => {
-  for (var n = r > 1 ? void 0 : r ? Le(e, t) : e, o = i.length - 1, s; o >= 0; o--)
+var Fe = Object.getOwnPropertyDescriptor, We = (i, e, t, r) => {
+  for (var n = r > 1 ? void 0 : r ? Fe(e, t) : e, o = i.length - 1, s; o >= 0; o--)
     (s = i[o]) && (n = s(n) || n);
   return n;
 }, z = (i, e) => (t, r) => e(t, r, i);
@@ -705,9 +899,9 @@ let B = class extends $ {
     return this._userManagerService.getCurrentUser();
   }
 };
-B = Fe([
+B = We([
   z(0, l(_)),
-  z(1, l(me))
+  z(1, l(Ee))
 ], B);
 const C = class C {
   static get() {
@@ -728,21 +922,43 @@ const C = class C {
   }
   /**
    * Rectangle utils, including range operations likes merge, subtract, split
+   *
+   * @example
+   * ```ts
+   * const ranges = [
+   *   { startRow: 0, startColumn: 0, endRow: 1, endColumn: 1 },
+   *   { startRow: 1, startColumn: 1, endRow: 2, endColumn: 2 }
+   * ];
+   * const merged = univerAPI.Util.rectangle.mergeRanges(ranges);
+   * console.log(merged);
+   * ```
    */
   get rectangle() {
-    return Ee;
+    return be;
   }
   /**
    * Number format utils, including parse and strigify about date, price, etc
+   *
+   * @example
+   * ```ts
+   * const text = univerAPI.Util.numfmt.format('#,##0.00', 1234.567);
+   * console.log(text);
+   * ```
    */
   get numfmt() {
-    return be;
+    return Se;
   }
   /**
    * common tools
+   *
+   * @example
+   * ```ts
+   * const key = univerAPI.Util.tools.generateRandomId(6);
+   * console.log(key);
+   * ```
    */
   get tools() {
-    return Se;
+    return Ce;
   }
 };
 /**
@@ -759,7 +975,7 @@ const w = Symbol("initializers");
 let U = class extends V {
   constructor(e, t, r, n) {
     super();
-    d(this, "_eventRegistry", new Ae());
+    d(this, "_eventRegistry", new Le());
     d(this, "registerEventHandler", (e, t) => this._eventRegistry.registerEventHandler(e, t));
     this._injector = e, this._commandService = t, this._univerInstanceService = r, this._lifecycleService = n, this.registerEventHandler(
       this.Event.LifeCycleChanged,
@@ -784,9 +1000,14 @@ let U = class extends V {
    * @static
    * @param {Univer | Injector} wrapped - The Univer instance or injector instance.
    * @returns {FUniver} - The FUniver instance.
+   *
+   * @example
+   * ```ts
+   * const univerAPI = FUniver.newAPI(univer);
+   * ```
    */
   static newAPI(e) {
-    return (e instanceof Ce ? e.__getInjector() : e).createInstance(U);
+    return (e instanceof De ? e.__getInjector() : e).createInstance(U);
   }
   /**
    * @ignore
@@ -907,6 +1128,16 @@ let U = class extends V {
    * Dispose the UniverSheet by the `unitId`. The UniverSheet would be unload from the application.
    * @param unitId The unit id of the UniverSheet.
    * @returns Whether the Univer instance is disposed successfully.
+   *
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const unitId = fWorkbook?.getId();
+   *
+   * if (unitId) {
+   *   univerAPI.disposeUnit(unitId);
+   * }
+   * ```
    */
   disposeUnit(e) {
     return this._univerInstanceService.disposeUnit(e);
@@ -914,6 +1145,12 @@ let U = class extends V {
   /**
    * Get the current lifecycle stage.
    * @returns {LifecycleStages} - The current lifecycle stage.
+   *
+   * @example
+   * ```ts
+   * const stage = univerAPI.getCurrentLifecycleStage();
+   * console.log(stage);
+   * ```
    */
   getCurrentLifecycleStage() {
     return this._injector.get(I).stage;
@@ -921,6 +1158,11 @@ let U = class extends V {
   /**
    * Undo an editing on the currently focused document.
    * @returns {Promise<boolean>} undo result
+   *
+   * @example
+   * ```ts
+   * univerAPI.undo();
+   * ```
    */
   undo() {
     return this._commandService.executeCommand(h.id);
@@ -928,13 +1170,18 @@ let U = class extends V {
   /**
    * Redo an editing on the currently focused document.
    * @returns {Promise<boolean>} redo result
+   *
+   * @example
+   * ```ts
+   * univerAPI.redo();
+   * ```
    */
   redo() {
     return this._commandService.executeCommand(u.id);
   }
   /**
    * Register a callback that will be triggered before invoking a command.
-   * @deprecated use `addEvent(univerAPI.event.BeforeCommandExecute, () => {})` instead.
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {})` instead.
    * @param {CommandListener} callback The callback.
    * @returns {IDisposable} The disposable instance.
    */
@@ -945,7 +1192,7 @@ let U = class extends V {
   }
   /**
    * Register a callback that will be triggered when a command is invoked.
-   * @deprecated use `addEvent(univerAPI.event.CommandExecuted, () => {})` instead.
+   * @deprecated use `univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {})` instead.
    * @param {CommandListener} callback The callback.
    * @returns {IDisposable} The disposable instance.
    */
@@ -960,6 +1207,14 @@ let U = class extends V {
    * @param params Parameters of this execution.
    * @param options Options of this execution.
    * @returns The result of the execution. It is a boolean value by default which indicates the command is executed.
+   *
+   * @example
+   * ```ts
+   * univerAPI.executeCommand('sheet.command.set-range-values', {
+   *   value: { v: "Hello, Univer!" },
+   *   range: { startRow: 0, startColumn: 0, endRow: 0, endColumn: 0 }
+   * });
+   * ```
    */
   executeCommand(e, t, r) {
     return this._commandService.executeCommand(e, t, r);
@@ -970,6 +1225,14 @@ let U = class extends V {
    * @param params Parameters of this execution.
    * @param options Options of this execution.
    * @returns The result of the execution. It is a boolean value by default which indicates the command is executed.
+   *
+   * @example
+   * ```ts
+   * univerAPI.syncExecuteCommand('sheet.command.set-range-values', {
+   *   value: { v: "Hello, Univer!" },
+   *   range: { startRow: 0, startColumn: 0, endRow: 0, endColumn: 0 }
+   * });
+   * ```
    */
   syncExecuteCommand(e, t, r) {
     return this._commandService.syncExecuteCommand(e, t, r);
@@ -998,9 +1261,13 @@ let U = class extends V {
    * @returns {Disposable} The Disposable instance, for remove the listener
    * @example
    * ```ts
-   * univerAPI.addEvent(univerAPI.event.UnitCreated, (params) => {
-   *   console.log('unit created', params);
+   * // Add life cycle changed event listener
+   * const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
+   *   const { stage } = params;
+   *   console.log('life cycle changed', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
    */
   addEvent(e, t) {
@@ -1014,7 +1281,7 @@ let U = class extends V {
    * @returns {boolean} should cancel
    * @example
    * ```ts
-   * this.fireEvent(univerAPI.event.UnitCreated, params);
+   * this.fireEvent(univerAPI.Event.LifeCycleChanged, params);
    * ```
    */
   fireEvent(e, t) {
@@ -1043,7 +1310,7 @@ let U = class extends V {
    * ```
    */
   newColor() {
-    return new De();
+    return new xe();
   }
   /**
    * Create a new rich text.
@@ -1051,11 +1318,13 @@ let U = class extends V {
    * @returns {RichTextBuilder} The new rich text instance
    * @example
    * ```ts
-   * const richText = univerAPI.newRichText();
+   * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
+   * const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
+   * range.setRichTextValueForCell(richText);
    * ```
    */
   newRichText(e) {
-    return xe.create(e);
+    return we.create(e);
   }
   /**
    * Create a new rich text value.
@@ -1063,11 +1332,13 @@ let U = class extends V {
    * @returns {RichTextValue} The new rich text value instance
    * @example
    * ```ts
-   * const richTextValue = univerAPI.newRichTextValue();
+   * const richTextValue = univerAPI.newRichTextValue({ body: { dataStream: 'Hello World\r\n' } });
+   * const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
+   * range.setRichTextValueForCell(richTextValue);
    * ```
    */
   newRichTextValue(e) {
-    return we.create(e);
+    return Te.create(e);
   }
   /**
    * Create a new paragraph style.
@@ -1075,11 +1346,15 @@ let U = class extends V {
    * @returns {ParagraphStyleBuilder} The new paragraph style instance
    * @example
    * ```ts
-   * const paragraphStyle = univerAPI.newParagraphStyle();
+   * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
+   * const paragraphStyle = univerAPI.newParagraphStyle({ textStyle: { ff: 'Arial', fs: 12, it: univerAPI.Enum.BooleanNumber.TRUE, bl: univerAPI.Enum.BooleanNumber.TRUE } });
+   * richText.insertParagraph(paragraphStyle);
+   * const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
+   * range.setRichTextValueForCell(richText);
    * ```
    */
   newParagraphStyle(e) {
-    return Te.create(e);
+    return Re.create(e);
   }
   /**
    * Create a new paragraph style value.
@@ -1091,7 +1366,7 @@ let U = class extends V {
    * ```
    */
   newParagraphStyleValue(e) {
-    return Re.create(e);
+    return Oe.create(e);
   }
   /**
    * Create a new text style.
@@ -1103,7 +1378,7 @@ let U = class extends V {
    * ```
    */
   newTextStyle(e) {
-    return Oe.create(e);
+    return Pe.create(e);
   }
   /**
    * Create a new text style value.
@@ -1115,7 +1390,7 @@ let U = class extends V {
    * ```
    */
   newTextStyleValue(e) {
-    return Pe.create(e);
+    return je.create(e);
   }
   /**
    * Create a new text decoration.
@@ -1127,7 +1402,7 @@ let U = class extends V {
    * ```
    */
   newTextDecoration(e) {
-    return new je(e);
+    return new Be(e);
   }
 };
 U = Ge([
@@ -1138,7 +1413,7 @@ U = Ge([
 ], U);
 export {
   $ as FBase,
-  Be as FBaseInitialable,
+  He as FBaseInitialable,
   S as FBlob,
   R as FEnum,
   O as FEventName,