@univerjs/core 0.6.0 → 0.6.1

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

@@ -23,7 +23,7 @@ export declare class FBlob extends FBase {
      * @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);
      * ```
@@ -35,8 +35,9 @@ export declare class FBlob extends FBase {
      * @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(contentType: string): FBlob;
@@ -45,9 +46,9 @@ export declare class FBlob extends FBase {
      * @returns
      * @example
      * ```ts
-     * const blob = univerAPI.newBlob(blob);
-     * const newBlob = blob.getDataAsString();
-     * console.log(newBlob);
+     * const blob = univerAPI.newBlob();
+     * const data = await blob.getDataAsString();
+     * console.log(data);
      * ```
      */
     getDataAsString(): Promise<string>;
@@ -57,9 +58,9 @@ export declare class FBlob extends FBase {
      * @returns the blob content as a string
      * @example
      * ```ts
-     * const blob = univerAPI.newBlob(blob);
-     * const newBlob = blob.getDataAsString('iso-8859-1');
-     * console.log(newBlob);
+     * const blob = univerAPI.newBlob();
+     * const data = await blob.getDataAsString('iso-8859-1');
+     * console.log(data);
      * ```
      */
     getDataAsString(charset?: string): Promise<string>;
@@ -68,9 +69,9 @@ export declare class FBlob extends FBase {
      * @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(): Promise<Uint8Array>;
@@ -114,9 +115,9 @@ export declare class FBlob extends FBase {
      * @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(): string | undefined;
@@ -126,9 +127,8 @@ export declare class FBlob extends FBase {
      * @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(contentType: string): FBlob;

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

@@ -1,4 +1,4 @@
-import { AutoFillSeries, BaselineOffset, BooleanNumber, BorderStyleTypes, BorderType, ColorType, CommandType, CommonHideTypes, CopyPasteType, DataValidationErrorStyle, DataValidationOperator, DataValidationRenderMode, DataValidationStatus, DataValidationType, DeleteDirection, DeveloperMetadataVisibility, Dimension, Direction, HorizontalAlign, InterpolationPointType, LifecycleStages, LocaleType, MentionType, ProtectionType, RelativeDate, SheetTypes, TextDecoration, TextDirection, ThemeColorType, UniverInstanceType, VerticalAlign } from '@univerjs/core';
+import { AutoFillSeries, BaselineOffset, BooleanNumber, BorderStyleTypes, BorderType, ColorType, CommandType, CommonHideTypes, CopyPasteType, DataValidationErrorStyle, DataValidationOperator, DataValidationRenderMode, DataValidationStatus, DataValidationType, DeleteDirection, DeveloperMetadataVisibility, Dimension, Direction, HorizontalAlign, InterpolationPointType, LifecycleStages, LocaleType, MentionType, ProtectionType, RelativeDate, SheetTypes, TextDecoration, TextDirection, ThemeColorType, UniverInstanceType, VerticalAlign, WrapStrategy } from '@univerjs/core';
 /**
  * @hideconstructor
  */
@@ -14,127 +14,291 @@ export declare class FEnum {
     static extend(source: any): void;
     constructor();
     /**
-     *  Defines different types of Univer instances
+     * Defines different types of Univer instances
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.UniverInstanceType.UNIVER_SHEET);
+     * ```
      */
     get UniverInstanceType(): typeof UniverInstanceType;
     /**
      * Represents different stages in the lifecycle
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.LifecycleStages.Rendered);
+     * ```
      */
     get LifecycleStages(): typeof LifecycleStages;
     /**
      * Different types of data validation
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.DataValidationType.LIST);
+     * ```
      */
     get DataValidationType(): typeof DataValidationType;
     /**
      * Different error display styles
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.DataValidationErrorStyle.WARNING);
+     * ```
      */
     get DataValidationErrorStyle(): typeof DataValidationErrorStyle;
     /**
      * Different validation rendering modes
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.DataValidationRenderMode.TEXT);
+     * ```
      */
     get DataValidationRenderMode(): typeof DataValidationRenderMode;
     /**
      * Different validation operators
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.DataValidationOperator.BETWEEN);
+     * ```
      */
     get DataValidationOperator(): typeof DataValidationOperator;
     /**
      * Different validation states
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.DataValidationStatus.VALID);
+     * ```
      */
     get DataValidationStatus(): typeof DataValidationStatus;
     /**
      * Different types of commands
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.CommandType.COMMAND);
+     * ```
      */
     get CommandType(): typeof CommandType;
     /**
      * Different baseline offsets for text baseline positioning
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.BaselineOffset.SUPERSCRIPT);
+     * ```
      */
     get BaselineOffset(): typeof BaselineOffset;
     /**
      * Boolean number representations
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.BooleanNumber.TRUE);
+     * ```
      */
     get BooleanNumber(): typeof BooleanNumber;
     /**
      * Different horizontal text alignment options
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.HorizontalAlign.CENTER);
+     * ```
      */
     get HorizontalAlign(): typeof HorizontalAlign;
     /**
      * Different text decoration styles
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.TextDecoration.DOUBLE);
+     * ```
      */
     get TextDecoration(): typeof TextDecoration;
     /**
      * Different text direction options
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.TextDirection.LEFT_TO_RIGHT);
+     * ```
      */
     get TextDirection(): typeof TextDirection;
     /**
      * Different vertical text alignment options
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.VerticalAlign.MIDDLE);
+     * ```
      */
     get VerticalAlign(): typeof VerticalAlign;
+    /**
+     * Different wrap strategy options
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.WrapStrategy.WRAP);
+     * ```
+     */
+    get WrapStrategy(): typeof WrapStrategy;
     /**
      * Different border types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.BorderType.OUTSIDE);
+     * ```
      */
     get BorderType(): typeof BorderType;
     /**
      * Different border style types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.BorderStyleTypes.NONE);
+     * ```
      */
     get BorderStyleTypes(): typeof BorderStyleTypes;
     /**
      * Auto fill series types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.AutoFillSeries.ALTERNATE_SERIES);
+     * ```
      */
     get AutoFillSeries(): typeof AutoFillSeries;
     /**
      * Color types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.ColorType.RGB);
+     * ```
      */
     get ColorType(): typeof ColorType;
     /**
      * Common hide types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.CommonHideTypes.ON);
+     * ```
      */
     get CommonHideTypes(): typeof CommonHideTypes;
     /**
      * Copy paste types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.CopyPasteType.PASTE_VALUES);
+     * ```
      */
     get CopyPasteType(): typeof CopyPasteType;
     /**
      * Delete direction types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.DeleteDirection.LEFT);
+     * ```
      */
     get DeleteDirection(): typeof DeleteDirection;
     /**
      * Developer metadata visibility types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.DeveloperMetadataVisibility.DOCUMENT);
+     * ```
      */
     get DeveloperMetadataVisibility(): typeof DeveloperMetadataVisibility;
     /**
      * Dimension types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.Dimension.ROWS);
+     * ```
      */
     get Dimension(): typeof Dimension;
     /**
      * Direction types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.Direction.UP);
+     * ```
      */
     get Direction(): typeof Direction;
     /**
      * Interpolation point types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.InterpolationPointType.NUMBER);
+     * ```
      */
     get InterpolationPointType(): typeof InterpolationPointType;
     /**
      * Locale types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.LocaleType.EN_US);
+     * ```
      */
     get LocaleType(): typeof LocaleType;
     /**
      * Mention types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.MentionType.PERSON);
+     * ```
      */
     get MentionType(): typeof MentionType;
     /**
      * Protection types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.ProtectionType.RANGE);
+     * ```
      */
     get ProtectionType(): typeof ProtectionType;
     /**
      * Relative date types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.RelativeDate.TODAY);
+     * ```
      */
     get RelativeDate(): typeof RelativeDate;
     /**
      * Sheet types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.SheetTypes.GRID);
+     * ```
      */
     get SheetTypes(): typeof SheetTypes;
     /**
      * Theme color types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.ThemeColorType.ACCENT1);
+     * ```
      */
     get ThemeColorType(): typeof ThemeColorType;
 }

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

@@ -16,8 +16,9 @@ export declare class FEventRegistry {
      * @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);
      * });
      * ```
      */
@@ -29,7 +30,7 @@ export declare class FEventRegistry {
      * @returns {boolean} should cancel
      * @example
      * ```ts
-     * this.fireEvent(univerAPI.event.UnitCreated, params);
+     * this.fireEvent(univerAPI.Event.LifeCycleChanged, params);
      * ```
      */
     fireEvent<T extends keyof IEventParamConfig>(event: T, params: IEventParamConfig[T]): boolean | undefined;

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

@@ -78,10 +78,12 @@ export declare class FEventName {
      * @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(): "DocCreated";
@@ -90,10 +92,12 @@ export declare class FEventName {
      * @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(): "DocDisposed";
@@ -102,10 +106,12 @@ export declare class FEventName {
      * @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(): "LifeCycleChanged";
@@ -114,10 +120,12 @@ export declare class FEventName {
      * @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(): "Redo";
@@ -126,10 +134,12 @@ export declare class FEventName {
      * @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(): "Undo";
@@ -138,10 +148,15 @@ export declare class FEventName {
      * @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(): "BeforeRedo";
@@ -150,10 +165,15 @@ export declare class FEventName {
      * @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(): "BeforeUndo";
@@ -162,10 +182,12 @@ export declare class FEventName {
      * @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(): "CommandExecuted";
@@ -174,10 +196,15 @@ export declare class FEventName {
      * @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(): "BeforeCommandExecute";

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

@@ -9,42 +9,42 @@ export declare class FHooks extends FBase {
     constructor(_injector: Injector, _lifecycleService: LifecycleService);
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged)` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onStarting(callback: () => void): IDisposable;
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged)` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onReady(callback: () => void): IDisposable;
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onRendered(callback: () => void): IDisposable;
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifecycleChanged, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onSteady(callback: () => void): IDisposable;
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeUndo, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {})` as instead
      */
     onBeforeUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Undo, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Undo, (event) => {})` as instead
      */
     onUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeRedo, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {})` as instead
      */
     onBeforeRedo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
      * @param callback
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Redo, () => {})` as instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Redo, (event) => {})` as instead
      */
     onRedo(callback: (action: IUndoRedoItem) => void): IDisposable;
 }