@univerjs/core 0.5.5 → 0.6.0-alpha.0

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

@@ -1223,10 +1223,10 @@ export declare class RichTextBuilder extends RichTextValue {
      * @example
      * ```ts
      * const richText = RichTextValue.create({ body: { dataStream: 'Hello World\r\n' } });
-     * const newRichText = richText.insertText(0, 'World');
+     * const newRichText = richText.insertText('World');
      * ```
      */
-    insertText(start: string, style?: TextStyleBuilder | ITextStyle): RichTextBuilder;
+    insertText(text: string, style?: TextStyleBuilder | ITextStyle): RichTextBuilder;
     /**
      * Inserts text into the rich text builder at the specified start position
      * @param start The start position of the text to insert
@@ -1361,8 +1361,7 @@ export declare class RichTextBuilder extends RichTextValue {
     cancelLink(start: number, end: number): RichTextBuilder;
     updateLink(id: string, url: string): RichTextBuilder;
     /**
-     * Inserts a new paragraph at the specified start position
-     * @param {number} start The start position of the paragraph to insert
+     * Inserts a new paragraph to the end
      * @param {ParagraphStyleBuilder} paragraphStyle The style of the paragraph to insert
      * @returns {RichTextBuilder} The current RichTextBuilder instance
      * @example

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

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

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

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

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

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

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

@@ -22,9 +22,18 @@ import { ProtectionType } from '../types/enum/protection-type';
 import { RelativeDate } from '../types/enum/relative-date';
 import { SheetTypes } from '../types/enum/sheet-types';
 import { ThemeColorType } from '../types/enum/theme-color-type';
+/**
+ * @hideconstructor
+ */
 export declare class FEnum {
+    /**
+     * @ignore
+     */
     static _instance: FEnum | null;
     static get(): FEnum;
+    /**
+     * @ignore
+     */
     static extend(source: any): void;
     constructor();
     /**

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

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

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

@@ -2,6 +2,9 @@ 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;

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;
+    addEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => 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/services/log/log.service.d.ts

@@ -12,16 +12,20 @@ export interface ILogService {
     log(...args: ArgsType): void;
     warn(...args: ArgsType): void;
     error(...args: ArgsType): void;
+    deprecate(...args: ArgsType): void;
     setLogLevel(enabled: LogLevel): void;
 }
 export declare const ILogService: import('@wendellhu/redi').IdentifierDecorator<ILogService>;
 export declare class DesktopLogService extends Disposable implements ILogService {
     private _logLevel;
+    private _deduction;
     debug(...args: ArgsType): void;
     log(...args: ArgsType): void;
     warn(...args: ArgsType): void;
     error(...args: ArgsType): void;
+    deprecate(...args: ArgsType): void;
     setLogLevel(logLevel: LogLevel): void;
     private _log;
+    private _logWithDeduplication;
 }
 export {};

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

@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * @ignore
+ */
 export type Nullable<T> = T | null | undefined | void;
 /**
  * Key value object

package/lib/types/types/enum/border-style-types.d.ts

@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Border style types enum
+ */
 export declare enum BorderStyleTypes {
     NONE = 0,
     THIN = 1,

package/lib/types/types/enum/text-style.d.ts

@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * An enum that specifies the text direction of a cell.
+ */
 export declare enum TextDirection {
     UNSPECIFIED = 0,
     LEFT_TO_RIGHT = 1,

package/lib/types/types/enum/theme-color-type.d.ts

@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Theme color type enum
+ */
 export declare enum ThemeColorType {
     /**
      * TEXT

package/lib/types/univer.d.ts

@@ -18,6 +18,9 @@ export interface IUniverConfig {
     logLevel: LogLevel;
     override?: DependencyOverride;
 }
+/**
+ * @hideconstructor
+ */
 export declare class Univer implements IDisposable {
     private _startedTypes;
     private _injector;
@@ -30,6 +33,9 @@ export declare class Univer implements IDisposable {
      * @param parentInjector An optional parent injector of the Univer injector. For more information, see https://redi.wendell.fun/docs/hierarchy.
      */
     constructor(config?: Partial<IUniverConfig>, parentInjector?: Injector);
+    /**
+     * @ignore
+     */
     __getInjector(): Injector;
     /**
      * Register a callback function which will be called when this Univer instance is disposing.