@univerjs/core 0.1.7 → 0.1.8

package/lib/types/services/resource-manager/type.d.ts

@@ -1,29 +1,26 @@
 import { IWorkbookData } from '../../types/interfaces/i-workbook-data';
-import { Workbook } from '../../sheets/workbook';
+import { UniverInstanceType } from '@univerjs/core';
 import { Observable } from 'rxjs';
 import { IDisposable } from '@wendellhu/redi';
 
+type IBusinessName = 'SHEET' | 'DOC';
+export type IResourceName = `${IBusinessName}_${string}_PLUGIN`;
 export interface IResourceHook<T = any> {
-    onChange: (unitID: string, resource: T) => void;
+    pluginName: IResourceName;
+    businesses: UniverInstanceType[];
+    onLoad: (unitID: string, resource: T) => void;
+    onUnLoad: (unitID: string) => void;
     toJson: (unitID: string) => string;
     parseJson: (bytes: string) => T;
 }
 export interface IResourceManagerService {
-    registerPluginResource: <T = any>(unitID: string, pluginName: string, hook: IResourceHook<T>) => IDisposable;
-    disposePluginResource: (unitID: string, pluginName: string) => void;
-    getAllResource: (unitID: string) => Array<{
-        unitID: string;
-        resourceName: string;
-        hook: IResourceHook;
-    }>;
-    register$: Observable<{
-        resourceName: string;
-        hook: IResourceHook;
-        unitID: string;
-    }>;
+    register$: Observable<IResourceHook>;
+    registerPluginResource: <T = any>(hook: IResourceHook<T>) => IDisposable;
+    disposePluginResource: (pluginName: IResourceName) => void;
+    getAllResourceHooks: () => IResourceHook[];
+    getResources: (unitId: string) => IWorkbookData['resources'];
+    loadResources: (unitId: string, resources: IWorkbookData['resources']) => void;
+    unloadResources(unitId: string): void;
 }
 export declare const IResourceManagerService: import('@wendellhu/redi').IdentifierDecorator<IResourceManagerService>;
-export interface ISnapshotPersistenceService {
-    saveWorkbook: (workbook: Workbook) => IWorkbookData;
-}
-export declare const ISnapshotPersistenceService: import('@wendellhu/redi').IdentifierDecorator<ISnapshotPersistenceService>;
+export {};

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

@@ -1,4 +1,4 @@
-import { Nullable } from '../../common/type-utils';
+import { Nullable } from '../../common/type-util';
 import { IUniverInstanceService } from '../instance/instance.service';
 import { IContextService } from '../context/context.service';
 import { IMutationInfo, CommandType, ICommandService } from '../command/command.service';
@@ -98,5 +98,5 @@ export declare class LocalUndoRedoService extends Disposable implements IUndoRed
     protected _getUndoStackForFocused(): IUndoRedoItem[];
     protected _getRedoStackForFocused(): IUndoRedoItem[];
     private _tryBatchingElements;
-    private _getFocusedUniverInstanceId;
+    private _getFocusedUnitId;
 }

package/lib/types/shared/__tests__/ref-alias.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

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

@@ -0,0 +1,5 @@
+import { IDocumentBody, ITextRun } from '../types/interfaces';
+
+export declare function getBodySliceHtml(body: IDocumentBody, startIndex: number, endIndex: number): string;
+export declare function convertBodyToHtml(body: IDocumentBody, withParagraphInfo?: boolean): string;
+export declare function covertTextRunToHtml(dataStream: string, textRun: ITextRun): string;

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

@@ -1,5 +1,5 @@
 import { ColorType, ThemeColors, ThemeColorType } from '../../types/enum';
-import { Nullable } from '../../common/type-utils';
+import { Nullable } from '../../common/type-util';
 
 export declare class ColorBuilder {
     private _themeValue;

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

@@ -36,4 +36,6 @@ export * from './sort-rules';
 export * from './tools';
 export * from './types';
 export * from './debounce';
+export * from './clipboard';
 export { queryObjectMatrix } from './object-matrix-query';
+export { moveRangeByOffset } from './range';

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

@@ -1,27 +1,32 @@
 import { Observer } from '../observer/observable';
-import { Nullable } from '../common/type-utils';
+import { Nullable } from '../common/type-util';
 import { Subscription, SubscriptionLike, Subject } from 'rxjs';
 import { IDisposable } from '@wendellhu/redi';
 
+type DisposableLike = IDisposable | Nullable<Observer<any>> | SubscriptionLike | (() => void);
+export declare function toDisposable(disposable: IDisposable): IDisposable;
 export declare function toDisposable(observer: Nullable<Observer<any>>): IDisposable;
 export declare function toDisposable(subscription: SubscriptionLike): IDisposable;
 export declare function toDisposable(callback: () => void): IDisposable;
+export declare function toDisposable(v: DisposableLike): IDisposable;
 /**
  * @deprecated use toDisposable instead
  */
 export declare function fromObservable(subscription: Subscription): IDisposable;
 export declare class DisposableCollection implements IDisposable {
     private readonly _disposables;
-    add(disposable: IDisposable): IDisposable;
+    add(disposable: DisposableLike): IDisposable;
     dispose(): void;
 }
 export declare class Disposable implements IDisposable {
     protected _disposed: boolean;
     private readonly _collection;
-    protected disposeWithMe(disposable: IDisposable | SubscriptionLike): IDisposable;
+    protected disposeWithMe(disposable: DisposableLike): IDisposable;
+    protected ensureNotDisposed(): void;
     dispose(): void;
 }
 export declare class RxDisposable extends Disposable implements IDisposable {
     protected dispose$: Subject<void>;
     dispose(): void;
 }
+export {};

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

@@ -0,0 +1,3 @@
+import { IRange } from '../types/interfaces/i-range';
+
+export declare function moveRangeByOffset(range: IRange, refOffsetX: number, refOffsetY: number, ignoreAbsolute?: boolean): IRange;

package/lib/types/sheets/__tests__/create-core-test-bed.d.ts

@@ -1,7 +1,7 @@
 import { IWorkbookData } from '../../types/interfaces/i-workbook-data';
-import { Univer } from '../../basics/univer';
+import { Univer } from '../../univer';
 
-export declare function createCoreTestBed(workbookConfig?: IWorkbookData): {
+export declare function createCoreTestBed(workbookData?: IWorkbookData): {
     univer: Univer;
     get: {
         <T>(id: import('@wendellhu/redi').DependencyIdentifier<T>, lookUp?: import('@wendellhu/redi').LookUp | undefined): T;

package/lib/types/sheets/column-manager.d.ts

@@ -1,6 +1,6 @@
 import { IColumnData, IRange, IWorksheetData } from '../types/interfaces';
 import { IObjectArrayPrimitiveType } from '../shared/object-matrix';
-import { Nullable } from '../common/type-utils';
+import { Nullable } from '../common/type-util';
 
 /**
  * Manage configuration information of all columns, get column width, column length, set column width, etc.

package/lib/types/sheets/row-manager.d.ts

@@ -1,3 +1,4 @@
+import { SheetViewModel } from './view-model';
 import { IRange, IRowData, IWorksheetData } from '../types/interfaces';
 import { Nullable } from '../shared/types';
 import { IObjectArrayPrimitiveType } from '../shared/object-matrix';
@@ -7,8 +8,9 @@ import { IObjectArrayPrimitiveType } from '../shared/object-matrix';
  */
 export declare class RowManager {
     private readonly _config;
+    private readonly _viewModel;
     private _rowData;
-    constructor(_config: IWorksheetData, data: IObjectArrayPrimitiveType<Partial<IRowData>>);
+    constructor(_config: IWorksheetData, _viewModel: SheetViewModel, data: IObjectArrayPrimitiveType<Partial<IRowData>>);
     /**
      * Get height and hidden status of columns in the sheet
      * @returns
@@ -43,7 +45,7 @@ export declare class RowManager {
      * @returns Visible rows range list
      */
     getVisibleRows(start?: number, end?: number): IRange[];
-    getRowVisible(rowPos: number): boolean;
+    getRowRawVisible(row: number): boolean;
     /**
      * Get count of row in the sheet
      * @returns

package/lib/types/sheets/view-model.d.ts

@@ -1,8 +1,11 @@
-import { ICellDataForSheetInterceptor } from '../types/interfaces/i-cell-data';
+import { ICellData, ICellDataForSheetInterceptor } from '../types/interfaces/i-cell-data';
 import { Disposable } from '../shared/lifecycle';
-import { Nullable } from '../common/type-utils';
+import { Nullable } from '../common/type-util';
 import { IDisposable } from '@wendellhu/redi';
 
+/**
+ * @internal
+ */
 export interface ICellContentInterceptor {
     getCell: (row: number, col: number) => Nullable<ICellDataForSheetInterceptor>;
 }
@@ -20,17 +23,22 @@ export interface ISheetViewModel {
     getCell: (row: number, col: number) => Nullable<ICellDataForSheetInterceptor>;
 }
 /**
- * SheetViewModel
+ * @internal
+ */
+export interface IRowFilteredInterceptor {
+    getRowFiltered(row: number): boolean;
+}
+/**
+ * @internal
  */
-export declare class SheetViewModel extends Disposable implements ISheetViewModel {
-    private readonly _cellContentInterceptors;
-    private readonly _rowFilteredInterceptors;
-    private readonly _rowVisibleInterceptors;
-    private readonly _colVisibleInterceptors;
+export declare class SheetViewModel extends Disposable {
+    private readonly getRawCell;
+    private _cellContentInterceptor;
+    private _rowFilteredInterceptor;
+    constructor(getRawCell: (row: number, col: number) => Nullable<ICellData>);
     dispose(): void;
     getCell(row: number, col: number): Nullable<ICellDataForSheetInterceptor>;
+    getRowFiltered(row: number): boolean;
     registerCellContentInterceptor(interceptor: ICellContentInterceptor): IDisposable;
     registerRowFilteredInterceptor(interceptor: IRowFilteredInterceptor): IDisposable;
-    registerRowVisibleInterceptor(interceptor: IRowVisibleInterceptor): IDisposable;
-    registerColVisibleInterceptor(interceptor: IColVisibleInterceptor): IDisposable;
 }

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

@@ -1,7 +1,7 @@
 import { Worksheet } from './worksheet';
 import { Styles } from './styles';
+import { UnitModel, UniverInstanceType } from '../common/unit';
 import { IGridRange, IRangeType, IWorkbookData, IWorksheetData } from '../types/interfaces';
-import { Disposable } from '../shared/lifecycle';
 import { Nullable } from '../shared';
 import { ILogService } from '../services/log/log.service';
 
@@ -9,8 +9,9 @@ export declare function getWorksheetUID(workbook: Workbook, worksheet: Worksheet
 /**
  * Access and create Univer Sheets files
  */
-export declare class Workbook extends Disposable {
+export declare class Workbook extends UnitModel<IWorkbookData, UniverInstanceType.UNIVER_SHEET> {
     private readonly _logService;
+    type: UniverInstanceType.UNIVER_SHEET;
     private readonly _sheetCreated$;
     readonly sheetCreated$: import('rxjs').Observable<Worksheet>;
     private readonly _sheetDisposed$;

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

@@ -11,6 +11,7 @@ import { Nullable, ObjectMatrix } from '../shared';
  * The model of a Worksheet.
  */
 export declare class Worksheet {
+    readonly unitId: string;
     private readonly _styles;
     protected _sheetId: string;
     protected _snapshot: IWorksheetData;
@@ -18,7 +19,7 @@ export declare class Worksheet {
     protected _rowManager: RowManager;
     protected _columnManager: ColumnManager;
     protected readonly _viewModel: SheetViewModel;
-    constructor(snapshot: Partial<IWorksheetData>, _styles: Styles);
+    constructor(unitId: string, snapshot: Partial<IWorksheetData>, _styles: Styles);
     /**
      * @internal
      * @param callback
@@ -45,6 +46,10 @@ export declare class Worksheet {
      * @returns Row Manager
      */
     getRowManager(): RowManager;
+    /**
+     * Returns the ID of its parent unit.
+     */
+    getUnitId(): string;
     /**
      * Returns the ID of the sheet represented by this object.
      * @returns ID of the sheet
@@ -70,13 +75,14 @@ export declare class Worksheet {
     getMergedCell(row: number, col: number): Nullable<IRange>;
     getCell(row: number, col: number): Nullable<ICellDataForSheetInterceptor>;
     getCellRaw(row: number, col: number): Nullable<ICellData>;
+    getRowFiltered(row: number): boolean;
     /**
      * Get cell matrix from a given range and pick out non-first cells of merged cells.
      *
      * 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.
      */
-    getMatrixWithMergedCells(row: number, col: number, endRow: number, endCol: number): ObjectMatrix<ICellData & {
+    getMatrixWithMergedCells(row: number, col: number, endRow: number, endCol: number, isRaw?: boolean): ObjectMatrix<ICellData & {
         rowSpan?: number;
         colSpan?: number;
     }>;
@@ -135,11 +141,22 @@ export declare class Worksheet {
     getColumnWidth(columnPosition: number): number;
     /**
      * Gets the height in pixels of the given row.
-     * @param rowPosition row index
+     * @param row row index
      * @returns Gets the height in pixels of the given row.
      */
-    getRowHeight(rowPosition: number): number;
+    getRowHeight(row: number): number;
+    /**
+     * Get if the row in visible. It may be affected by features like filter and view.
+     * @param row the row index
+     * @returns if the row in visible to the user
+     */
     getRowVisible(row: number): boolean;
+    /**
+     * Get if the row does not have `hidden` property.
+     * @param row the row index
+     * @returns if the row does not have `hidden` property
+     */
+    getRowRawVisible(row: number): boolean;
     getHiddenRows(start?: number, end?: number): IRange[];
     getColVisible(col: number): boolean;
     getHiddenCols(start?: number, end?: number): IRange[];
@@ -173,14 +190,22 @@ export declare class Worksheet {
      * Iterate a range row by row.
      *
      * Performance intensive.
+     *
+     * @param range the iterate range
+     * @param skipEmpty whether to skip empty cells, default to be `true`
      */
-    iterateByRow(range: IRange): Iterator<Readonly<ICell>, Readonly<ICell>>;
+    iterateByRow(range: IRange, skipEmpty?: boolean): Iterable<Readonly<ICell>>;
     /**
      * Iterate a range column by column. This is pretty similar to `iterateByRow` but with different order.
      *
      * Performance intensive.
+     *
+     * @param range The iterate range.
+     * @param skipEmpty Whether to skip empty cells, default to be `true`.
+     * @param skipNonTopLeft Whether to skip non-top-left cells of merged cells, default to be `true`. If the
+     * parameter is set to `false`, the iterator will return cells in the top row.
      */
-    iterateByColumn(range: IRange): Iterator<Readonly<ICell>, Readonly<ICell>>;
+    iterateByColumn(range: IRange, skipEmpty?: boolean, skipNonTopLeft?: boolean): Iterable<Readonly<ICell>>;
 }
 /**
  * A cell info including its span (if it is the top-left cell of a merged cell).
@@ -190,11 +215,11 @@ export interface ICell {
     col: number;
     rowSpan?: number;
     colSpan?: number;
-    value: ICellData;
+    value: Nullable<ICellData>;
 }
 /**
  * Get pure text in a cell.
  * @param cell
  * @returns pure text in this cell
  */
-export declare function extractPureTextFromCell(cell: ICellData): string;
+export declare function extractPureTextFromCell(cell: Nullable<ICellData>): string;

package/lib/types/slides/{domain/slide-model.d.ts → slide-model.d.ts}

@@ -1,6 +1,8 @@
-import { ISlideData, ISlidePage } from '../../types/interfaces';
+import { ISlideData, ISlidePage } from '../types/interfaces';
+import { UnitModel, UniverInstanceType } from '../common/unit';
 
-export declare class SlideDataModel {
+export declare class SlideDataModel extends UnitModel<ISlideData, UniverInstanceType.UNIVER_SLIDE> {
+    type: UniverInstanceType.UNIVER_SLIDE;
     private _snapshot;
     private _unitId;
     constructor(snapshot: Partial<ISlideData>);
@@ -14,9 +16,9 @@ export declare class SlideDataModel {
     getPageOrder(): string[] | undefined;
     getPage(pageId: string): ISlidePage | undefined;
     getElementsByPage(pageId: string): {
-        [elementId: string]: import('../../types/interfaces').IPageElement;
+        [elementId: string]: import('../types/interfaces').IPageElement;
     } | undefined;
-    getElement(pageId: string, elementId: string): import('../../types/interfaces').IPageElement | undefined;
-    getPageSize(): import('../..').ISize;
+    getElement(pageId: string, elementId: string): import('../types/interfaces').IPageElement | undefined;
+    getPageSize(): import('..').ISize;
     addPage(): ISlidePage;
 }

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

@@ -17,7 +17,6 @@ export * from './auto-fill-series';
 export * from './border-style-types';
 export * from './color-type';
 export * from './common-hide-types';
-export * from './condition-type';
 export * from './copy-paste-type';
 export * from './developer-metadata-visibility';
 export * from './dimension';

package/lib/types/types/interfaces/i-cell-custom-render.d.ts

@@ -14,6 +14,8 @@ export interface ICellRenderContext {
 }
 /**
  * @debt This shouldn't exist in core package.
+ *
+ * @deprecated This interface is subject to change in the future.
  */
 export interface ICellCustomRender {
     drawWith(ctx: CanvasRenderingContext2D, info: ICellRenderContext, skeleton: any, spreadsheets: any): void;

package/lib/types/types/interfaces/i-cell-data.d.ts

@@ -33,6 +33,10 @@ export interface ICellData {
      * Id of the formula.
      */
     si?: Nullable<string>;
+    /**
+     * User stored custom fields
+     */
+    custom?: Nullable<Record<string, any>>;
 }
 export interface ICellMarksStyle {
     color: string;

package/lib/types/types/interfaces/i-range.d.ts

@@ -97,6 +97,9 @@ export interface IUnitRangeName {
 export interface IUnitRange extends IGridRange {
     unitId: string;
 }
+export interface IUnitRangeWithName extends IUnitRange {
+    sheetName: string;
+}
 /**
  * One of the range types,
  *

package/lib/types/types/interfaces/i-style-data.d.ts

@@ -136,6 +136,12 @@ export interface IStyleBase {
      * (Subscript 下标 /Superscript上标 Text)
      */
     va?: Nullable<BaselineOffset>;
+    /**
+     * Numfmt pattern
+     */
+    n?: Nullable<{
+        pattern: string;
+    }>;
 }
 /**
  * Properties of cell style

package/lib/types/types/interfaces/i-univer-data.d.ts

@@ -1,6 +1,7 @@
 import { LocaleType } from '../enum';
 import { ILocales } from '../../shared/locale';
 import { IStyleSheet } from '../../services/theme/theme.service';
+import { DependencyOverride } from '../../services/plugin/plugin-override';
 import { LogLevel } from '../../services/log/log.service';
 
 export interface IUniverData {
@@ -9,17 +10,5 @@ export interface IUniverData {
     locales: ILocales;
     logLevel: LogLevel;
     id: string;
-}
-/**
- * Toolbar Observer generic interface, convenient for plug-ins to define their own types
- */
-export interface UIObserver<T = string> {
-    /**
-     * fontSize, fontFamily,color...
-     */
-    name: string;
-    /**
-     * fontSize:number, fontFamily:string ...
-     */
-    value?: T;
+    override?: DependencyOverride;
 }

package/lib/types/univer.d.ts

@@ -0,0 +1,43 @@
+import { Plugin, PluginCtor } from './services/plugin/plugin';
+import { UnitModel, UnitType } from './common/unit';
+import { IDocumentData, ISlideData, IUniverData, IWorkbookData } from './types/interfaces';
+import { LocaleType } from './types/enum/locale-type';
+import { SlideDataModel } from './slides/slide-model';
+import { Workbook } from './sheets/workbook';
+import { DocumentDataModel } from './docs/data-model/document-data-model';
+import { Injector } from '@wendellhu/redi';
+
+export declare class Univer {
+    private _startedTypes;
+    private _injector;
+    private get _univerInstanceService();
+    private get _pluginService();
+    /**
+     * Create a Univer instance.
+     * @param config Configuration data for Univer
+     * @param parentInjector An optional parent injector of the Univer injector. For more information, see https://redi.wendell.fun/docs/hierarchy.
+     */
+    constructor(config?: Partial<IUniverData>, parentInjector?: Injector);
+    __getInjector(): Injector;
+    dispose(): void;
+    setLocale(locale: LocaleType): void;
+    createUnit<T, U extends UnitModel>(type: UnitType, data: Partial<T>): U;
+    /**
+     * Create a univer sheet instance with internal dependency injection.
+     *
+     * @deprecated use `createUnit` instead
+     */
+    createUniverSheet(data: Partial<IWorkbookData>): Workbook;
+    /**
+     * @deprecated use `createUnit` instead
+     */
+    createUniverDoc(data: Partial<IDocumentData>): DocumentDataModel;
+    /**
+     * @deprecated use `createUnit` instead
+     */
+    createUniverSlide(data: Partial<ISlideData>): SlideDataModel;
+    private _init;
+    private _tryProgressToReady;
+    /** Register a plugin into univer. */
+    registerPlugin<T extends PluginCtor<Plugin>>(plugin: T, config?: ConstructorParameters<T>[0]): void;
+}