@univerjs/core 1.0.0-insiders.20260813-7c9aa50 → 1.0.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 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

package/README.md

@@ -37,4 +37,3 @@ const univer = new Univer({
 - [Documentation](https://docs.univer.ai)
 - [NPM package](https://npmjs.com/package/@univerjs/core)
 - [GitHub repository](https://github.com/dream-num/univer)
-

package/lib/cjs/facade.js

@@ -81,7 +81,7 @@ var FBaseInitialable = class extends _univerjs_core.Disposable {
 };
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/decorateParam.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateParam.js
 function __decorateParam(paramIndex, decorator) {
 	return function(target, key) {
 		decorator(target, key, paramIndex);
@@ -89,7 +89,7 @@ function __decorateParam(paramIndex, decorator) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/decorate.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -120,9 +120,9 @@ let FBlob = _FBlob = class FBlob extends FBase {
 		return this._injector.createInstance(_FBlob, this._blob);
 	}
 	/**
-	* Return the data inside this object as a blob converted to the specified content type.
+	* Returns a copy labeled with the specified MIME type. The data bytes are not converted or re-encoded.
 	* @param contentType the content type refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
-	* @returns a new blob by converting the current blob to the specified content type
+	* @returns {FBlob} A new facade containing the same data with the specified MIME type.
 	* @example
 	* ```ts
 	* const blob = univerAPI.newBlob();
@@ -148,10 +148,10 @@ let FBlob = _FBlob = class FBlob extends FBase {
 	}
 	/**
 	* Gets the data stored in this blob.
-	* @returns the blob content as a byte array
+	* @returns {Promise<Uint8Array>} A promise resolving to the bytes; rejects if no blob data is set.
 	* @example
 	* ```ts
-	* const blob = univerAPI.newBlob();
+	* const blob = univerAPI.newBlob().setDataFromString('Hello, World!');
 	* const bytes = await blob.getBytes();
 	* console.log(bytes);
 	* ```
@@ -182,7 +182,7 @@ let FBlob = _FBlob = class FBlob extends FBase {
 	}
 	/**
 	* Gets the content type of the data stored in this blob.
-	* @returns the content type
+	* @returns {string | undefined} The MIME type, or `undefined` if no blob data is set.
 	* @example
 	* ```ts
 	* const blob = univerAPI.newBlob();
@@ -195,7 +195,7 @@ let FBlob = _FBlob = class FBlob extends FBase {
 		return (_this$_blob = this._blob) === null || _this$_blob === void 0 ? void 0 : _this$_blob.type;
 	}
 	/**
-	* Sets the content type of the data stored in this blob.
+	* Sets the MIME type without converting or re-encoding the data bytes. Has no effect when no blob data is set.
 	* @param contentType the content type refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
 	* @returns the blob object
 	* @example
@@ -213,7 +213,7 @@ let FBlob = _FBlob = class FBlob extends FBase {
 FBlob = _FBlob = __decorate([__decorateParam(1, (0, _univerjs_core.Inject)(_univerjs_core.Injector))], FBlob);
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/typeof.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
 	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -224,7 +224,7 @@ function _typeof(o) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/toPrimitive.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -237,14 +237,14 @@ function toPrimitive(t, r) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/toPropertyKey.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/defineProperty.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -275,6 +275,18 @@ function _defineProperty(e, r, t) {
 * @hideconstructor
 */
 var FEnum = class FEnum {
+	/** SpreadsheetML formula types. */
+	get FormulaType() {
+		return _univerjs_core.FormulaType;
+	}
+	/** Worksheet hiding states: VISIBLE (0), HIDDEN (1), VERY_HIDDEN (2). */
+	get WorksheetHiddenState() {
+		return _univerjs_core.WorksheetHiddenState;
+	}
+	/**
+	* Returns the shared registry of Facade enum values.
+	* @returns {FEnum} The registry also exposed by `univerAPI.Enum`.
+	*/
 	static get() {
 		if (this._instance) return this._instance;
 		const instance = new FEnum();
@@ -428,6 +440,17 @@ var FEnum = class FEnum {
 		return _univerjs_core.HorizontalAlign;
 	}
 	/**
+	* Named paragraph style types
+	*
+	* @example
+	* ```ts
+	* console.log(univerAPI.Enum.NamedStyleType.HEADING_1);
+	* ```
+	*/
+	get NamedStyleType() {
+		return _univerjs_core.NamedStyleType;
+	}
+	/**
 	* Paragraph line-height interpretation modes
 	*
 	* @example
@@ -714,6 +737,10 @@ _defineProperty(FEnum, "_instance", void 0);
 * @hideconstructor
 */
 var FEventName = class FEventName {
+	/**
+	* Returns the shared registry of Facade event names.
+	* @returns {FEventName} The registry also exposed by `univerAPI.Event`.
+	*/
 	static get() {
 		if (this._instance) return this._instance;
 		const instance = new FEventName();
@@ -912,6 +939,13 @@ var FEventRegistry = class {
 		if (!this._eventRegistry.has(event)) this._eventRegistry.set(event, new _univerjs_core.Registry());
 		return this._eventRegistry.get(event);
 	}
+	/**
+	* Registers a factory for the underlying subscription that produces an event.
+	* The factory starts when the event has listeners; its subscription is disposed when the last listener is removed.
+	* @param {string} event The event name.
+	* @param {() => IDisposable | Subscription} handler Creates the underlying event subscription.
+	* @returns {IDisposable} Unregisters the factory and disposes its active subscription.
+	*/
 	registerEventHandler(event, handler) {
 		const current = this._eventHandlerMap.get(event);
 		if (current) current.add(handler);
@@ -924,6 +958,11 @@ var FEventRegistry = class {
 			(_this$_eventHandlerRe2 = this._eventHandlerRegisted.get(event)) === null || _this$_eventHandlerRe2 === void 0 || _this$_eventHandlerRe2.delete(handler);
 		});
 	}
+	/**
+	* Removes one event listener and stops underlying subscriptions when no listeners remain.
+	* @param {T} event The event name.
+	* @param {(params: IEventParamConfig[T]) => void} callback The previously registered callback.
+	*/
 	removeEvent(event, callback) {
 		const map = this._ensureEventRegistry(event);
 		map.delete(callback);
@@ -947,9 +986,9 @@ var FEventRegistry = class {
 	}
 	/**
 	* Add an event listener
-	* @param {string} event key of event
-	* @param {(params: IEventParamConfig[typeof event]) => void} callback callback when event triggered
-	* @returns {Disposable} The Disposable instance, for remove the listener
+	* @param {T} event key of event
+	* @param {(params: IEventParamConfig[T]) => void} callback callback when event triggered
+	* @returns {IDisposable} A disposable that removes the event listener.
 	* @example
 	* ```ts
 	* univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
@@ -965,9 +1004,9 @@ var FEventRegistry = class {
 	}
 	/**
 	* Fire an event, used in internal only.
-	* @param {string} event key of event
-	* @param {any} params params of event
-	* @returns {boolean} should cancel
+	* @param {T} event key of event
+	* @param {IEventParamConfig[T]} params params of event
+	* @returns {boolean | undefined} The event's `cancel` value after listeners run; `undefined` if it was not set.
 	* @example
 	* ```ts
 	* this.fireEvent(univerAPI.Event.LifeCycleChanged, params);
@@ -1094,7 +1133,7 @@ var _FUniver;
 const InitializerSymbol = Symbol("initializers");
 let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	/**
-	* Create an FUniver instance, if the injector is not provided, it will create a new Univer instance.
+	* Creates a Facade API instance for an existing Univer instance or its injector.
 	* @static
 	* @param {Univer | Injector} wrapped - The Univer instance or injector instance.
 	* @returns {FUniver} - The FUniver instance.
@@ -1110,7 +1149,7 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	/**
 	* @ignore
 	*/
-	_initialize(injector) {}
+	_initialize(_injector) {}
 	/**
 	* @ignore
 	*/
@@ -1122,11 +1161,11 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 					initializers = [];
 					this.prototype[InitializerSymbol] = initializers;
 				}
-				initializers.push(source.prototype._initialize);
-			} else if (name !== "constructor") this.prototype[name] = source.prototype[name];
+				initializers.push(Reflect.get(source.prototype, name));
+			} else if (name !== "constructor") Reflect.set(this.prototype, name, Reflect.get(source.prototype, name));
 		});
 		Object.getOwnPropertyNames(source).forEach((name) => {
-			if (name !== "prototype" && name !== "name" && name !== "length") this[name] = source[name];
+			if (name !== "prototype" && name !== "name" && name !== "length") Reflect.set(this, name, Reflect.get(source, name));
 		});
 	}
 	constructor(_injector, _commandService, _univerInstanceService, _lifecycleService) {
@@ -1136,9 +1175,20 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 		this._univerInstanceService = _univerInstanceService;
 		this._lifecycleService = _lifecycleService;
 		_defineProperty(this, "_eventRegistry", new FEventRegistry());
-		_defineProperty(this, "registerEventHandler", (event, handler) => {
-			return this._eventRegistry.registerEventHandler(event, handler);
-		});
+		_defineProperty(
+			this,
+			/**
+			* Registers a factory for the subscription that produces an event.
+			* The factory starts when listeners exist and its subscription is disposed when the last listener is removed.
+			* @param event The event name.
+			* @param handler Creates the underlying event subscription.
+			* @returns A disposable that unregisters the factory and disposes its active subscription.
+			*/
+			"registerEventHandler",
+			(event, handler) => {
+				return this._eventRegistry.registerEventHandler(event, handler);
+			}
+		);
 		this.disposeWithMe(this.registerEventHandler(this.Event.LifeCycleChanged, () => (0, _univerjs_core.toDisposable)(this._lifecycleService.lifecycle$.subscribe((stage) => {
 			this.fireEvent(this.Event.LifeCycleChanged, { stage });
 		}))));
@@ -1149,12 +1199,9 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 			this.dispose();
 		});
 		const initializers = Object.getPrototypeOf(this)[InitializerSymbol];
-		if (initializers) {
-			const self = this;
-			initializers.forEach(function(fn) {
-				fn.apply(self, [_injector]);
-			});
-		}
+		if (initializers) initializers.forEach((fn) => {
+			fn.call(this, this._injector);
+		});
 	}
 	_initCommandEvent(injector) {
 		const commandService = injector.get(_univerjs_core.ICommandService);
@@ -1257,8 +1304,8 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 		})));
 	}
 	/**
-	* Dispose the UniverSheet by the `unitId`. The UniverSheet would be unload from the application.
-	* @param unitId The unit id of the UniverSheet.
+	* Disposes the document, workbook, or other Univer unit identified by `unitId`, unloading it from the application.
+	* @param unitId The ID of the unit to dispose.
 	* @returns Whether the Univer instance is disposed successfully.
 	*
 	* @example
@@ -1391,6 +1438,40 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 		this._injector.get(_univerjs_core.LocaleService).setLocale(locale);
 	}
 	/**
+	* Set the region used for locale-sensitive formatting.
+	* @param {string} region - A unique region identifier.
+	* @example
+	* ```ts
+	* univerAPI.setRegion('enUS');
+	* ```
+	*/
+	setRegion(region) {
+		this._injector.get(_univerjs_core.RegionService).setRegion(region);
+	}
+	/**
+	* Get the region currently used for locale-sensitive formatting.
+	* @returns {string} The current region identifier.
+	* @example
+	* ```ts
+	* const currentRegion = univerAPI.getCurrentRegion();
+	* console.log(currentRegion);
+	* ```
+	*/
+	getCurrentRegion() {
+		return this._injector.get(_univerjs_core.RegionService).getCurrentRegion();
+	}
+	/**
+	* Set the current layout direction.
+	* @param {('ltr' | 'rtl')} direction - The layout direction.
+	* @example
+	* ```ts
+	* univerAPI.setDirection('rtl');
+	* ```
+	*/
+	setDirection(direction) {
+		this._injector.get(_univerjs_core.LocaleService).setDirection(direction);
+	}
+	/**
 	* Get the current locale.
 	* @returns {string} The current locale identifier.
 	* @example
@@ -1417,9 +1498,9 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	/**
 	* Execute a command with the given id and parameters.
 	* @param id Identifier of the command.
-	* @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.
+	* @param [params] Parameters of this execution.
+	* @param [options] Options of this execution.
+	* @returns {Promise<R>} The result of the execution. It is a boolean value by default which indicates the command is executed.
 	*
 	* @example
 	* ```ts
@@ -1435,8 +1516,8 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	/**
 	* Execute a command with the given id and parameters synchronously.
 	* @param id Identifier of the command.
-	* @param params Parameters of this execution.
-	* @param options Options of this execution.
+	* @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
@@ -1450,20 +1531,29 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	syncExecuteCommand(id, params, options) {
 		return this._commandService.syncExecuteCommand(id, params, options);
 	}
+	/**
+	* Enums exposed by the registered Facade extensions.
+	*/
 	get Enum() {
 		return FEnum.get();
 	}
+	/**
+	* Event names to use with `addEvent`.
+	*/
 	get Event() {
 		return FEventName.get();
 	}
+	/**
+	* Utility functions exposed by the registered Facade extensions.
+	*/
 	get Util() {
 		return FUtil.get();
 	}
 	/**
 	* Add an event listener
-	* @param {string} event key of event
-	* @param {(params: IEventParamConfig[typeof event]) => void} callback callback when event triggered
-	* @returns {Disposable} The Disposable instance, for remove the listener
+	* @param {T} event key of event
+	* @param {(params: IEventParamConfig[T]) => void} callback callback when event triggered
+	* @returns {IDisposable} A disposable that removes the event listener.
 	* @example
 	* ```ts
 	* // Add life cycle changed event listener
@@ -1481,9 +1571,9 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	}
 	/**
 	* Fire an event, used in internal only.
-	* @param {string} event key of event
-	* @param {any} params params of event
-	* @returns {boolean} should cancel
+	* @param {T} event key of event
+	* @param {IEventParamConfig[T]} params params of event
+	* @returns {boolean | undefined} The event's `cancel` value after listeners run; `undefined` if it was not set.
 	* @example
 	* ```ts
 	* this.fireEvent(univerAPI.Event.LifeCycleChanged, params);
@@ -1492,6 +1582,14 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	fireEvent(event, params) {
 		return this._eventRegistry.fireEvent(event, params);
 	}
+	/**
+	* Gets the facade for reading the current user.
+	* @returns {FUserManager} The user manager facade.
+	* @example
+	* ```ts
+	* const user = univerAPI.getUserManager().getCurrentUser();
+	* ```
+	*/
 	getUserManager() {
 		return this._injector.createInstance(FUserManager);
 	}
@@ -1512,9 +1610,9 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	* @example
 	* ```ts
 	* const richText = univerAPI.newRichText()
-	*   .align({ horizontal: univerAPI.Enum.HorizontalAlign.CENTER })
-	*   .text('Status: ')
-	*   .span('Ready', { bold: true, color: '#16a34a' });
+	*   .text('Read ')
+	*   .link('Univer documentation', 'https://docs.univer.ai')
+	*   .text(' for details.');
 	* ```
 	*/
 	newRichText() {
@@ -1552,7 +1650,7 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	* This is an advanced document-model API. Application and agent code should normally use
 	* `newRichText().paragraph({ ... })`.
 	*
-	* @param {IParagraphStyle} style The paragraph style
+	* @param {IParagraphStyle} [style] The paragraph style
 	* @returns {ParagraphStyleBuilder} The new paragraph style instance
 	* @advanced
 	*/
@@ -1561,7 +1659,7 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	}
 	/**
 	* Create a new paragraph style value.
-	* @param {IParagraphStyle} style - The paragraph style
+	* @param {IParagraphStyle} [style] - The paragraph style
 	* @returns {ParagraphStyleValue} The new paragraph style value instance
 	* @example
 	* ```ts
@@ -1573,7 +1671,7 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	}
 	/**
 	* Create a new text style.
-	* @param {ITextStyle} style - The text style
+	* @param {ITextStyle} [style] - The text style
 	* @returns {TextStyleBuilder} The new text style instance
 	* @example
 	* ```ts
@@ -1585,7 +1683,7 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	}
 	/**
 	* Create a new text style value.
-	* @param {ITextStyle} style - The text style
+	* @param {ITextStyle} [style] - The text style
 	* @returns {TextStyleValue} The new text style value instance
 	* @example
 	* ```ts
@@ -1597,7 +1695,7 @@ let FUniver = _FUniver = class FUniver extends _univerjs_core.Disposable {
 	}
 	/**
 	* Create a new text decoration.
-	* @param {ITextDecoration} decoration - The text decoration
+	* @param {ITextDecoration} [decoration] - The text decoration
 	* @returns {TextDecorationBuilder} The new text decoration instance
 	* @example
 	* ```ts