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

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

@@ -2,56 +2,43 @@ import { IDisposable, Injector } from '../common/di';
 import { IUndoRedoItem } from '../services/undoredo/undoredo.service';
 import { LifecycleService } from '../services/lifecycle/lifecycle.service';
 import { FBase } from './f-base';
+/**
+ * @hideconstructor
+ */
 export declare class FHooks extends FBase {
     protected readonly _injector: Injector;
     private readonly _lifecycleService;
     constructor(_injector: Injector, _lifecycleService: LifecycleService);
     /**
-     * The onStarting event is fired when lifecycle stage is Starting.
-     * @param callback Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged)` as instead
      */
     onStarting(callback: () => void): IDisposable;
     /**
-     * The onReady event is fired when lifecycle stage is Ready.
-     * @param callback Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged)` as instead
      */
     onReady(callback: () => void): IDisposable;
     /**
-     * The onRendered event is fired when lifecycle stage is Rendered.
-     * @param callback Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged, () => {})` as instead
      */
     onRendered(callback: () => void): IDisposable;
     /**
-     * The onSteady event is fired when lifecycle stage is Steady.
-     * @param callback Callback function that will be called when the event is fired
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged, () => {})` as instead
      */
     onSteady(callback: () => void): IDisposable;
     /**
-     * Hook that fires before an undo operation is executed.
-     * @param callback Function to be called when the event is triggered
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeUndo, () => {})` as instead
      */
     onBeforeUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
-     * Hook that fires after an undo operation is executed.
-     * @param callback Function to be called when the event is triggered
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Undo, () => {})` as instead
      */
     onUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
-     * Hook that fires before a redo operation is executed.
-     * @param callback Function to be called when the event is triggered
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeRedo, () => {})` as instead
      */
     onBeforeRedo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
-     * Hook that fires after a redo operation is executed.
-     * @param callback Function to be called when the event is triggered
-     * @returns A disposable object that can be used to unsubscribe from the event
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Redo, () => {})` as instead
      */
     onRedo(callback: (action: IUndoRedoItem) => void): IDisposable;
 }

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

@@ -15,6 +15,12 @@ import { FEnum } from './f-enum';
 import { FHooks } from './f-hooks';
 import { FUserManager } from './f-usermanager';
 import { FUtil } from './f-util';
+/**
+ * The root Facade API object to interact with Univer. Please use `newAPI` static method
+ * to create a new instance.
+ *
+ * @hideconstructor
+ */
 export declare class FUniver extends FBaseInitialable {
     protected readonly _injector: Injector;
     protected readonly _commandService: ICommandService;
@@ -94,21 +100,21 @@ export declare class FUniver extends FBaseInitialable {
     get Util(): FUtil;
     /**
      * Add an event listener
-     * @param event key of event
-     * @param callback callback when event triggered
+     * @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
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.UnitCreated, (params) => {
-     *     console.log('unit created', params);
+     *   console.log('unit created', params);
      * });
      * ```
      */
     addEvent(event: keyof IEventParamConfig, callback: (params: IEventParamConfig[typeof event]) => void): IDisposable;
     /**
      * Fire an event, used in internal only.
-     * @param event {string} key of event
-     * @param params {any} params of event
+     * @param {string} event key of event
+     * @param {any} params params of event
      * @returns {boolean} should cancel
      * @example
      * ```ts
@@ -118,7 +124,7 @@ export declare class FUniver extends FBaseInitialable {
     protected fireEvent<T extends keyof IEventParamConfig>(event: T, params: IEventParamConfig[T]): boolean | undefined;
     /**
      * Get the callback map corresponding to the event
-     * @param event
+     * @param {keyof IEventParamConfig} event
      * @returns {number} The number of callbacks
      */
     protected hasEventCallback(event: keyof IEventParamConfig): boolean;
@@ -128,7 +134,7 @@ export declare class FUniver extends FBaseInitialable {
      * @returns {FBlob} The new blob instance
      * @example
      * ```ts
-     * const blob = univerApi.newBlob();
+     * const blob = univerAPI.newBlob();
      * ```
      */
     newBlob(): FBlob;
@@ -137,69 +143,78 @@ export declare class FUniver extends FBaseInitialable {
      * @returns {ColorBuilder} The new color instance
      * @example
      * ```ts
-     * const color = univerApi.newColor();
+     * const color = univerAPI.newColor();
      * ```
      */
     newColor(): ColorBuilder;
     /**
      * Create a new rich text.
-     * @param data
+     * @param {IDocumentData} data
      * @returns {RichTextBuilder} The new rich text instance
      * @example
      * ```ts
-     * const richText = univerApi.newRichText();
+     * const richText = univerAPI.newRichText();
      * ```
      */
     newRichText(data?: IDocumentData): RichTextBuilder;
     /**
      * Create a new rich text value.
-     * @param data - The rich text data
+     * @param {IDocumentData} data - The rich text data
      * @returns {RichTextValue} The new rich text value instance
      * @example
      * ```ts
-     * const richTextValue = univerApi.newRichTextValue();
+     * const richTextValue = univerAPI.newRichTextValue();
      * ```
      */
     newRichTextValue(data: IDocumentData): RichTextValue;
     /**
      * Create a new paragraph style.
-     * @param style - The paragraph style
+     * @param {IParagraphStyle} style - The paragraph style
      * @returns {ParagraphStyleBuilder} The new paragraph style instance
      * @example
      * ```ts
-     * const paragraphStyle = univerApi.newParagraphStyle();
+     * const paragraphStyle = univerAPI.newParagraphStyle();
      * ```
      */
     newParagraphStyle(style?: IParagraphStyle): ParagraphStyleBuilder;
     /**
      * Create a new paragraph style value.
-     * @param style - The paragraph style
+     * @param {IParagraphStyle} style - The paragraph style
      * @returns {ParagraphStyleValue} The new paragraph style value instance
      * @example
      * ```ts
-     * const paragraphStyleValue = univerApi.newParagraphStyleValue();
+     * const paragraphStyleValue = univerAPI.newParagraphStyleValue();
      * ```
      */
     newParagraphStyleValue(style?: IParagraphStyle): ParagraphStyleValue;
     /**
      * Create a new text style.
-     * @param style - The text style
+     * @param {ITextStyle} style - The text style
      * @returns {TextStyleBuilder} The new text style instance
      * @example
      * ```ts
-     * const textStyle = univerApi.newTextStyle();
+     * const textStyle = univerAPI.newTextStyle();
      * ```
      */
     newTextStyle(style?: ITextStyle): TextStyleBuilder;
     /**
      * Create a new text style value.
-     * @param style - The text style
+     * @param {ITextStyle} style - The text style
      * @returns {TextStyleValue} The new text style value instance
      * @example
      * ```ts
-     * const textStyleValue = univerApi.newTextStyleValue();
+     * const textStyleValue = univerAPI.newTextStyleValue();
      * ```
      */
     newTextStyleValue(style?: ITextStyle): TextStyleValue;
+    /**
+     * Create a new text decoration.
+     * @param {ITextDecoration} decoration - The text decoration
+     * @returns {TextDecorationBuilder} The new text decoration instance
+     * @example
+     * ```ts
+     * const decoration = univerAPI.newTextDecoration();
+     * ```
+     */
     newTextDecoration(decoration?: ITextDecoration): TextDecorationBuilder;
 }

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

@@ -1,6 +1,9 @@
 import { IUser, UserManagerService } from '../services/user-manager/user-manager.service';
 import { Injector } from '../common/di';
 import { FBase } from './f-base';
+/**
+ * @hideconstructor
+ */
 export declare class FUserManager extends FBase {
     protected readonly _injector: Injector;
     private readonly _userManagerService;

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

@@ -1,7 +1,16 @@
 import { Rectangle, Tools } from '../shared';
+/**
+ * @ignore
+ */
 export declare class FUtil {
+    /**
+     * @ignore
+     */
     static _instance: FUtil | null;
     static get(): FUtil;
+    /**
+     * @ignore
+     */
     static extend(source: any): void;
     /**
      * Rectangle utils, including range operations likes merge, subtract, split

package/lib/types/index.d.ts

@@ -17,7 +17,7 @@ export { debounce, get, merge, mergeWith, set } from 'lodash-es';
 export { textDiff } from './shared/text-diff';
 export { dedupe, groupBy, makeArray, remove, rotate } from './common/array';
 export { isBooleanString } from './common/boolean';
-export { createInternalEditorID, DEFAULT_EMPTY_DOCUMENT_VALUE, DOCS_FORMULA_BAR_EDITOR_UNIT_ID_KEY, DOCS_NORMAL_EDITOR_UNIT_ID_KEY, DOCS_ZEN_EDITOR_UNIT_ID_KEY, IS_ROW_STYLE_PRECEDE_COLUMN_STYLE, isInternalEditorID, } from './common/const';
+export * from './common/const';
 export * from './common/di';
 export { shallowEqual } from './common/equal';
 export { ParagraphStyleBuilder, ParagraphStyleValue, RichTextBuilder, RichTextValue, TextDecorationBuilder, TextStyleBuilder, TextStyleValue } from './docs/data-model/rich-text-builder';
@@ -53,8 +53,7 @@ export { updateAttributeByDelete } from './docs/data-model/text-x/apply-utils/de
 export { updateAttributeByInsert } from './docs/data-model/text-x/apply-utils/insert-apply';
 export { TextX } from './docs/data-model/text-x/text-x';
 export type { TPriority } from './docs/data-model/text-x/text-x';
-export { composeBody, getBodySlice, SliceBodyType } from './docs/data-model/text-x/utils';
-export { getCustomDecorationSlice, getCustomRangeSlice, normalizeBody } from './docs/data-model/text-x/utils';
+export { composeBody, getBodySlice, getCustomBlockSlice, getCustomDecorationSlice, getCustomRangeSlice, getParagraphsSlice, getSectionBreakSlice, getTableSlice, getTextRunSlice, normalizeBody, SliceBodyType, } from './docs/data-model/text-x/utils';
 export { EventState, EventSubject, fromEventSubject, type IEventObserver } from './observer/observable';
 export { AuthzIoLocalService } from './services/authz-io/authz-io-local.service';
 export { IAuthzIoService } from './services/authz-io/type';

package/lib/types/services/config/config.service.d.ts

@@ -19,7 +19,7 @@ interface IConfigOptions {
     merge?: boolean;
 }
 export interface IConfigService {
-    getConfig<T>(id: string): Nullable<T>;
+    getConfig<T>(id: string | symbol): Nullable<T>;
     setConfig(id: string | symbol, value: unknown, options?: IConfigOptions): void;
     deleteConfig(id: string): boolean;
     subscribeConfigValue$<T = unknown>(key: string): Observable<T>;

package/lib/types/services/context/context.d.ts

@@ -23,6 +23,7 @@ export declare const EDITOR_ACTIVATED = "EDITOR_ACTIVATED";
 export declare const FOCUSING_EDITOR_INPUT_FORMULA = "FOCUSING_EDITOR_INPUT_FORMULA";
 /** The focusing state of the formula editor (Fx bar). */
 export declare const FOCUSING_FX_BAR_EDITOR = "FOCUSING_FX_BAR_EDITOR";
+/** The focusing state of the cell editor. */
 export declare const FOCUSING_UNIVER_EDITOR = "FOCUSING_UNIVER_EDITOR";
 export declare const FOCUSING_EDITOR_STANDALONE = "FOCUSING_EDITOR_INPUT_FORMULA";
 /** The focusing state of the editor in side panel, such as Chart Editor Panel. */

package/lib/types/shared/index.d.ts

@@ -30,7 +30,7 @@ export * from './hash-algorithm';
 export * from './lifecycle';
 export * from './locale';
 export { LRUHelper, LRUMap } from './lru/lru-map';
-export { numfmt } from './numfmt';
+export { type INumfmtLocalTag, numfmt } from './numfmt';
 export * from './object-matrix';
 export { queryObjectMatrix } from './object-matrix-query';
 export { moveRangeByOffset, splitIntoGrid } from './range';

package/lib/types/shared/numfmt.d.ts

@@ -1,3 +1,3 @@
-import { INumfmt } from './types/numfmt.type';
+import { INumfmt, LocaleTag } from './types/numfmt.type';
 declare const numfmt: INumfmt;
-export { numfmt };
+export { LocaleTag as INumfmtLocalTag, numfmt };

package/lib/types/shared/types/numfmt.type.d.ts

@@ -181,7 +181,7 @@ interface Formatter {
     dateInfo: DateInfo;
     (value: number): string;
 }
-type LocaleTag = 'zh-CN' | 'zh' | 'zh-TW' | 'cs' | 'da' | 'nl' | 'en' | 'fi' | 'fr' | 'de' | 'el' | 'hu' | 'is' | 'id' | 'it' | 'ja' | 'ko' | 'nb' | 'pl' | 'pt' | 'ru' | 'sk' | 'es' | 'sv' | 'th' | 'tr';
+export type LocaleTag = 'zh-CN' | 'zh-TW' | 'cs' | 'da' | 'nl' | 'en' | 'fi' | 'fr' | 'de' | 'el' | 'hu' | 'is' | 'id' | 'it' | 'ja' | 'ko' | 'nb' | 'pl' | 'pt' | 'ru' | 'sk' | 'es' | 'sv' | 'th' | 'tr' | 'vi';
 export interface ParsedReturnType {
     /**
      * The parsed value. For dates, this will be an Excel style serial date unless the nativeDate option is used.