@univerjs/core 1.0.0-rc.0 → 1.0.0

package/lib/es/facade.js

@@ -1,4 +1,4 @@
-import { AbsoluteRefType, AutoFillSeries, BaselineOffset, BooleanNumber, BorderStyleTypes, BorderType, CanceledError, ColorType, CommandType, CommonHideTypes, CopyPasteType, DataValidationErrorStyle, DataValidationOperator, DataValidationRenderMode, DataValidationStatus, DataValidationType, DeleteDirection, DeveloperMetadataVisibility, Dimension, Direction, Disposable, HorizontalAlign, ICommandService, IUniverInstanceService, ImageSourceType, Inject, Injector, InterpolationPointType, LifecycleService, LifecycleStages, LocaleService, LocaleType, MentionType, NamedStyleType, NumberUnitType, ParagraphStyleBuilder, ParagraphStyleValue, PresetListType, ProtectionType, Rectangle, RedoCommand, RegionService, Registry, RelativeDate, RichTextBuilder, RichTextValue, SheetTypes, SpacingRule, TextDecoration, TextDecorationBuilder, TextDirection, TextStyleBuilder, TextStyleValue, ThemeColorType, ThemeService, Tools, UndoCommand, Univer, UniverInstanceType, UserManagerService, VerticalAlign, WrapStrategy, numfmt, toDisposable } from "@univerjs/core";
+import { AbsoluteRefType, AutoFillSeries, BaselineOffset, BooleanNumber, BorderStyleTypes, BorderType, CanceledError, ColorType, CommandType, CommonHideTypes, CopyPasteType, DataValidationErrorStyle, DataValidationOperator, DataValidationRenderMode, DataValidationStatus, DataValidationType, DeleteDirection, DeveloperMetadataVisibility, Dimension, Direction, Disposable, FormulaType, HorizontalAlign, ICommandService, IUniverInstanceService, ImageSourceType, Inject, Injector, InterpolationPointType, LifecycleService, LifecycleStages, LocaleService, LocaleType, MentionType, NamedStyleType, NumberUnitType, ParagraphStyleBuilder, ParagraphStyleValue, PresetListType, ProtectionType, Rectangle, RedoCommand, RegionService, Registry, RelativeDate, RichTextBuilder, RichTextValue, SheetTypes, SpacingRule, TextDecoration, TextDecorationBuilder, TextDirection, TextStyleBuilder, TextStyleValue, ThemeColorType, ThemeService, Tools, UndoCommand, Univer, UniverInstanceType, UserManagerService, VerticalAlign, WorksheetHiddenState, WrapStrategy, numfmt, toDisposable } from "@univerjs/core";
 
 //#region src/facade/f-base.ts
 /**
@@ -80,7 +80,7 @@ var FBaseInitialable = class extends 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);
@@ -88,7 +88,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);
@@ -119,9 +119,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();
@@ -147,10 +147,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);
 	* ```
@@ -181,7 +181,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();
@@ -194,7 +194,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
@@ -212,7 +212,7 @@ let FBlob = _FBlob = class FBlob extends FBase {
 FBlob = _FBlob = __decorate([__decorateParam(1, Inject(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) {
@@ -223,7 +223,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];
@@ -236,14 +236,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,
@@ -274,6 +274,18 @@ function _defineProperty(e, r, t) {
 * @hideconstructor
 */
 var FEnum = class FEnum {
+	/** SpreadsheetML formula types. */
+	get FormulaType() {
+		return FormulaType;
+	}
+	/** Worksheet hiding states: VISIBLE (0), HIDDEN (1), VERY_HIDDEN (2). */
+	get WorksheetHiddenState() {
+		return 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();
@@ -724,6 +736,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();
@@ -922,6 +938,13 @@ var FEventRegistry = class {
 		if (!this._eventRegistry.has(event)) this._eventRegistry.set(event, new 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);
@@ -934,6 +957,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);
@@ -957,9 +985,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) => {
@@ -975,9 +1003,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);
@@ -1104,7 +1132,7 @@ var _FUniver;
 const InitializerSymbol = Symbol("initializers");
 let FUniver = _FUniver = class FUniver extends 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.
@@ -1146,9 +1174,20 @@ let FUniver = _FUniver = class FUniver extends 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, () => toDisposable(this._lifecycleService.lifecycle$.subscribe((stage) => {
 			this.fireEvent(this.Event.LifeCycleChanged, { stage });
 		}))));
@@ -1264,8 +1303,8 @@ let FUniver = _FUniver = class FUniver extends 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
@@ -1458,9 +1497,9 @@ let FUniver = _FUniver = class FUniver extends 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
@@ -1476,8 +1515,8 @@ let FUniver = _FUniver = class FUniver extends 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
@@ -1491,20 +1530,29 @@ let FUniver = _FUniver = class FUniver extends 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
@@ -1522,9 +1570,9 @@ let FUniver = _FUniver = class FUniver extends 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);
@@ -1533,6 +1581,14 @@ let FUniver = _FUniver = class FUniver extends 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);
 	}
@@ -1593,7 +1649,7 @@ let FUniver = _FUniver = class FUniver extends 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
 	*/
@@ -1602,7 +1658,7 @@ let FUniver = _FUniver = class FUniver extends 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
@@ -1614,7 +1670,7 @@ let FUniver = _FUniver = class FUniver extends 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
@@ -1626,7 +1682,7 @@ let FUniver = _FUniver = class FUniver extends 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
@@ -1638,7 +1694,7 @@ let FUniver = _FUniver = class FUniver extends 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