@univerjs/core 0.5.1 → 0.5.2

package/lib/types/common/interceptor.d.ts

@@ -9,6 +9,11 @@ export interface IInterceptor<M, C> {
     handler: InterceptorHandler<M, C>;
 }
 export interface ICellInterceptor<M, C> extends IInterceptor<M, C> {
+    /**
+     * The effect of the interceptor handler.
+     * If the effect is 'Style', the worksheet@getCellValueOnly will bypass this interceptor.
+     * If the effect is 'Value', the worksheet@getStyleOnly will bypass this interceptor.
+     */
     effect?: InterceptorEffectEnum;
 }
 export declare function createInterceptorKey<T, C>(key: string): IInterceptor<T, C>;

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

@@ -0,0 +1,133 @@
+import { Nullable } from '../shared';
+import { Injector } from '@wendellhu/redi';
+import { FBase } from './f-base';
+export interface IFBlobSource {
+    /**
+     * Return the data inside this object as a blob.
+     */
+    getBlob(): FBlob;
+    /**
+     * Return the data inside this object as a blob converted to the specified content type.
+     * @param contentType the content type refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
+     */
+    getAs(contentType: string): FBlob;
+}
+export declare class FBlob extends FBase {
+    private _blob;
+    protected readonly _injector: Injector;
+    constructor(_blob: Nullable<Blob>, _injector: Injector);
+    /**
+     * Returns a copy of this blob.
+     * @returns a new blob by copying the current blob
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob(blob);
+     * const newBlob = blob.copyBlob();
+     * console.log(newBlob);
+     * ```
+     */
+    copyBlob(): FBlob;
+    /**
+     * Return the data inside this object as a blob converted to the specified content type.
+     * @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
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob(blob);
+     * const newBlob = blob.getBlob();
+     * ```
+     */
+    getAs(contentType: string): FBlob;
+    /**
+     * get the blob as a string
+     * @returns
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob(blob);
+     * const newBlob = blob.getDataAsString();
+     * console.log(newBlob);
+     * ```
+     */
+    getDataAsString(): Promise<string>;
+    /**
+     * get the blob as a string
+     * @param charset the charset
+     * @returns the blob content as a string
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob(blob);
+     * const newBlob = blob.getDataAsString('iso-8859-1');
+     * console.log(newBlob);
+     * ```
+     */
+    getDataAsString(charset?: string): Promise<string>;
+    /**
+     * Gets the data stored in this blob.
+     * @returns the blob content as a byte array
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob(blob);
+     * const newBlob = blob.getBytes();
+     * console.log(newBlob);
+     * ```
+     */
+    getBytes(): Promise<Uint8Array>;
+    /**
+     * Sets the data stored in this blob.
+     * @param bytes a byte array
+     * @returns the blob object
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob();
+     * const bytes = new Uint8Array(10);
+     * blob.setBytes(bytes);
+     * ```
+     */
+    setBytes(bytes: Uint8Array): FBlob;
+    /**
+     * Sets the data stored in this blob.
+     * @param data blob data string
+     * @returns the blob object
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob();
+     * blob.setDataFromString('Hello, World!');
+     * ```
+     */
+    setDataFromString(data: string): FBlob;
+    /**
+     * Sets the data stored in this blob.
+     * @param data a string
+     * @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
+     * ```ts
+     * const blob = UniverApi.newBlob();
+     * blob.setDataFromString('Hello, World!', 'text/plain');
+     * ```
+     */
+    setDataFromString(data: string, contentType?: string): FBlob;
+    /**
+     * Gets the content type of the data stored in this blob.
+     * @returns the content type
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob(blob);
+     * const newBlob = blob.getContentType();
+     * console.log(newBlob);
+     * ```
+     */
+    getContentType(): string | undefined;
+    /**
+     * Sets the content type of the data stored in this blob.
+     * @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
+     * ```ts
+     * const blob = UniverApi.newBlob(blob);
+     * const newBlob = blob.setContentType('text/plain');
+     * console.log(newBlob);
+     * ```
+     */
+    setContentType(contentType: string): FBlob;
+}

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

@@ -4,7 +4,9 @@ import { LifecycleStages } from '../services/lifecycle/lifecycle';
 import { IUniverInstanceService } from '../services/instance/instance.service';
 import { Univer } from '../univer';
 import { FBase } from './f-base';
+import { FBlob } from './f-blob';
 import { FHooks } from './f-hooks';
+import { FUserManager } from './f-usermanager';
 export declare class FUniver extends FBase {
     protected readonly _injector: Injector;
     protected readonly _commandService: ICommandService;
@@ -80,4 +82,15 @@ export declare class FUniver extends FBase {
      * @returns {FHooks} FHooks instance
      */
     getHooks(): FHooks;
+    /**
+     * Create a new blob.
+     *
+     * @returns {FBlob} The new blob instance
+     * @example
+     * ```ts
+     * const blob = UniverApi.newBlob();
+     * ```
+     */
+    newBlob(): FBlob;
+    getUserManager(): FUserManager;
 }

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

@@ -0,0 +1,14 @@
+import { IUser, UserManagerService } from '../services/user-manager/user-manager.service';
+import { Injector } from '../common/di';
+import { FBase } from './f-base';
+export declare class FUserManager extends FBase {
+    protected readonly _injector: Injector;
+    private readonly _userManagerService;
+    constructor(_injector: Injector, _userManagerService: UserManagerService);
+    /**
+     * Get current user info
+     * @example
+     * `univerAPI.getUserManager().getCurrentUser()`
+     */
+    getCurrentUser(): IUser;
+}

package/lib/types/index.d.ts

@@ -22,7 +22,7 @@ export * from './common/di';
 export { shallowEqual } from './common/equal';
 export { CustomCommandExecutionError } from './common/error';
 export { throttle } from './common/function';
-export type { ICellInterceptor, IComposeInterceptors, IInterceptor, InterceptorHandler } from './common/interceptor';
+export type { IAsyncInterceptor, ICellInterceptor, IComposeInterceptors, IInterceptor, InterceptorHandler } from './common/interceptor';
 export { AsyncInterceptorManager, composeInterceptors, createAsyncInterceptorKey, createInterceptorKey, InterceptorEffectEnum, InterceptorManager } from './common/interceptor';
 export type { Serializable } from './common/json';
 export { MemoryCursor } from './common/memory-cursor';
@@ -30,6 +30,7 @@ export { mixinClass } from './common/mixin';
 export { FBase } from './facade/f-base';
 export { FUniver } from './facade/f-univer';
 export { FHooks } from './facade/f-hooks';
+export { FBlob, type IFBlobSource } from './facade/f-blob';
 export { isNumeric, isSafeNumeric } from './common/number';
 export { Registry, RegistryAsMap } from './common/registry';
 export { requestImmediateMacroTask } from './common/request-immediate-macro-task';
@@ -96,7 +97,7 @@ export { Range } from './sheets/range';
 export { DEFAULT_WORKSHEET_COLUMN_COUNT, DEFAULT_WORKSHEET_COLUMN_COUNT_KEY, DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT, DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT_KEY, DEFAULT_WORKSHEET_COLUMN_WIDTH, DEFAULT_WORKSHEET_COLUMN_WIDTH_KEY, DEFAULT_WORKSHEET_ROW_COUNT, DEFAULT_WORKSHEET_ROW_COUNT_KEY, DEFAULT_WORKSHEET_ROW_HEIGHT, DEFAULT_WORKSHEET_ROW_HEIGHT_KEY, DEFAULT_WORKSHEET_ROW_TITLE_WIDTH, DEFAULT_WORKSHEET_ROW_TITLE_WIDTH_KEY, mergeWorksheetSnapshotWithDefault, } from './sheets/sheet-snapshot-utils';
 export { Styles } from './sheets/styles';
 export * from './sheets/typedef';
-export { addLinkToDocumentModel, isRangesEqual, isUnitRangesEqual } from './sheets/util';
+export { addLinkToDocumentModel, isNotNullOrUndefined, isRangesEqual, isUnitRangesEqual } from './sheets/util';
 export { SheetViewModel } from './sheets/view-model';
 export { createDocumentModelWithStyle } from './sheets/util';
 export { ImageCacheMap } from './shared/cache/image-cache';

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

@@ -1,7 +1,7 @@
+import { ILanguagePack, ILocales, LanguageValue } from '../../shared/locale';
 import { Subject } from 'rxjs';
 import { Disposable } from '../../shared/lifecycle';
 import { LocaleType } from '../../types/enum/locale-type';
-import { ILanguagePack, ILocales, LanguageValue } from '../../shared/locale';
 /**
  * This service provides i18n and timezone / location features to other modules.
  */

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

@@ -11,7 +11,9 @@ export declare function toDisposable(v: DisposableLike): IDisposable;
 export declare function fromObservable(subscription: Subscription): IDisposable;
 export declare class DisposableCollection implements IDisposable {
     private readonly _disposables;
-    add(disposable: DisposableLike): IDisposable;
+    add(disposable: DisposableLike): {
+        dispose: (notDisposeSelf?: boolean) => void;
+    };
     dispose(): void;
 }
 export declare class Disposable implements IDisposable {

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

@@ -16,6 +16,7 @@ export declare class Tools {
      */
     static generateRandomId(n?: number, alphabet?: string): string;
     static getClassName(instance: object): string;
+    /** @deprecated This method is deprecated, please use `import { merge } from '@univerjs/core` instead */
     static deepMerge(target: any, ...sources: any[]): any;
     static numberFixed(value: number, digit: number): number;
     static diffValue(one: any, two: any): boolean;

package/lib/types/sheets/typedef.d.ts

@@ -101,6 +101,10 @@ export interface IWorksheetData {
         hidden?: BooleanNumber;
     };
     showGridlines: BooleanNumber;
+    /**
+     * Color of the gridlines.
+     */
+    gridlinesColor?: string;
     rightToLeft: BooleanNumber;
 }
 export type CustomData = Nullable<Record<string, any>>;
@@ -549,4 +553,14 @@ export interface ITextRangeParam extends ITextRange {
  * @deprecated please use worksheet.getCellInfoInMergeData instead
  */
 export declare function getCellInfoInMergeData(row: number, column: number, mergeData?: IRange[]): ISelectionCell;
+export type ICellDataWithSpanAndDisplay = ICellData & {
+    rowSpan?: number;
+    colSpan?: number;
+    displayV?: string;
+};
+export declare enum CellModeEnum {
+    Raw = "raw",
+    Intercepted = "intercepted",
+    Both = "both"
+}
 export {};

package/lib/types/sheets/util.d.ts

@@ -36,3 +36,4 @@ export declare function extractOtherStyle(style?: Nullable<IStyleData>): ICellSt
  */
 export declare function getFontFormat(format?: Nullable<IStyleData>): IStyleBase;
 export declare function addLinkToDocumentModel(documentModel: DocumentDataModel, linkUrl: string, linkId: string): void;
+export declare function isNotNullOrUndefined<T>(value: T | null | undefined): value is T;

package/lib/types/sheets/worksheet.d.ts

@@ -1,7 +1,7 @@
 import { Nullable, ObjectMatrix } from '../shared';
 import { IPaddingData, IStyleData, ITextRotation } from '../types/interfaces';
 import { Styles } from './styles';
-import { ICellData, ICellDataForSheetInterceptor, IFreeze, IRange, ISelectionCell, IWorksheetData } from './typedef';
+import { ICellData, ICellDataForSheetInterceptor, ICellDataWithSpanAndDisplay, IFreeze, IRange, ISelectionCell, IWorksheetData, CellModeEnum } from './typedef';
 import { DocumentDataModel } from '../docs';
 import { BooleanNumber, CellValueType, HorizontalAlign, TextDirection, VerticalAlign, WrapStrategy } from '../types/enum';
 import { ColumnManager } from './column-manager';
@@ -158,6 +158,8 @@ export declare class Worksheet {
     getMergeData(): IRange[];
     /**
      * Get the merged cell Range of the sheet cell.
+     * If (row, col) is not in a merged cell, return null
+     *
      * @param {number} row The row index of test cell
      * @param {number} col The column index of test cell
      * @returns {Nullable<IRange>} The merged cell range of the cell, if the cell is not in a merged cell, return null
@@ -232,11 +234,11 @@ export declare class Worksheet {
      *
      * Notice that `ICellData` here is not after copying. In another word, the object matrix here should be
      * considered as a slice of the original worksheet data matrix.
+     *
+     * Control the v attribute in the return cellData.v through dataMode
      */
-    getMatrixWithMergedCells(row: number, col: number, endRow: number, endCol: number, isRaw?: boolean): ObjectMatrix<ICellData & {
-        rowSpan?: number;
-        colSpan?: number;
-    }>;
+    getMatrixWithMergedCells(row: number, col: number, endRow: number, endCol: number): ObjectMatrix<ICellDataWithSpanAndDisplay>;
+    getMatrixWithMergedCells(row: number, col: number, endRow: number, endCol: number, dataMode: CellModeEnum): ObjectMatrix<ICellDataWithSpanAndDisplay>;
     getRange(range: IRange): Range;
     getRange(startRow: number, startColumn: number): Range;
     getRange(startRow: number, startColumn: number, endRow: number, endColumn: number): Range;
@@ -280,9 +282,14 @@ export declare class Worksheet {
     isSheetHidden(): BooleanNumber;
     /**
      * Returns true if the sheet's gridlines are hidden; otherwise returns false. Gridlines are visible by default.
-     * @returns Gridlines Hidden Status
+     * @returns {boolean} Gridlines Hidden Status.
      */
     hasHiddenGridlines(): boolean;
+    /**
+     * Returns the color of the gridlines, or undefined if the gridlines are not colored.
+     * @returns {string | undefined} returns the color of the gridlines, or undefined if the gridlines are default.
+     */
+    getGridlinesColor(): string | undefined;
     /**
      * Gets the sheet tab color, or null if the sheet tab has no color.
      * @returns the sheet tab color or null
@@ -346,6 +353,7 @@ export declare class Worksheet {
      * @returns the position of the last column that has content.
      */
     getLastColumnWithContent(): number;
+    getDataRangeScope(): IRange;
     cellHasValue(value: ICellData): boolean;
     /**
      * Iterate a range row by row.

package/lib/types/univer.d.ts

@@ -1,14 +1,14 @@
+import { IDisposable, Injector } from './common/di';
 import { UnitModel, UnitType } from './common/unit';
 import { LogLevel } from './services/log/log.service';
 import { Plugin, PluginCtor } from './services/plugin/plugin';
 import { DependencyOverride } from './services/plugin/plugin-override';
 import { IStyleSheet } from './services/theme/theme.service';
-import { ILocales } from './shared';
 import { IWorkbookData } from './sheets/typedef';
 import { LocaleType } from './types/enum/locale-type';
 import { IDocumentData, ISlideData } from './types/interfaces';
-import { Injector } from './common/di';
 import { DocumentDataModel } from './docs/data-model/document-data-model';
+import { ILocales } from './shared';
 import { Workbook } from './sheets/workbook';
 import { SlideDataModel } from './slides/slide-model';
 export interface IUniverConfig {
@@ -18,11 +18,12 @@ export interface IUniverConfig {
     logLevel: LogLevel;
     override?: DependencyOverride;
 }
-export declare class Univer {
+export declare class Univer implements IDisposable {
     private _startedTypes;
     private _injector;
     private get _univerInstanceService();
     private get _pluginService();
+    private _disposingCallbacks;
     /**
      * Create a Univer instance.
      * @param config Configuration data for Univer
@@ -30,6 +31,15 @@ export declare class Univer {
      */
     constructor(config?: Partial<IUniverConfig>, parentInjector?: Injector);
     __getInjector(): Injector;
+    /**
+     * Register a callback function which will be called when this Univer instance is disposing.
+     *
+     * @ignore
+     *
+     * @param callback The callback function.
+     * @returns To remove this callback function from this Univer instance's on disposing list.
+     */
+    onDispose(callback: () => void): IDisposable;
     dispose(): void;
     setLocale(locale: LocaleType): void;
     createUnit<T, U extends UnitModel>(type: UnitType, data: Partial<T>): U;