@univerjs/core 0.3.0 → 0.4.0-alpha.0

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

@@ -1,17 +1,15 @@
-/**
- * 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.
- */
+import { Dependency, DependencyIdentifier, Injector } from '@wendellhu/redi';
 export * from '@wendellhu/redi';
 export * from '@wendellhu/redi/react-bindings';
+/**
+ * Register the dependencies to the injector.
+ * @param injector The injector to register the dependencies.
+ * @param dependencies The dependencies to register.
+ */
+export declare function registerDependencies(injector: Injector, dependencies: Dependency[]): void;
+/**
+ * Touch a group of dependencies to ensure they are instantiated.
+ * @param injector The injector to touch the dependencies.
+ * @param dependencies The dependencies to touch.
+ */
+export declare function touchDependencies(injector: Injector, dependencies: [DependencyIdentifier<unknown>][]): void;

package/lib/types/docs/data-model/text-x/build-utils/index.d.ts

@@ -25,6 +25,7 @@ export declare class BuildTextUtils {
     static transform: {
         getPlainText: (dataStream: string) => string;
         fromPlainText: (text: string) => import('../../../..').IDocumentBody;
+        isEmptyDocument: (dataStream?: string) => boolean;
     };
 }
 export type { IAddCustomRangeTextXParam, IDeleteCustomRangeParam, IReplaceSelectionTextXParams } from './text-x-utils';

package/lib/types/docs/data-model/text-x/build-utils/parse.d.ts

@@ -1,3 +1,4 @@
 import { IDocumentBody } from '../../../../types/interfaces';
 export declare const getPlainText: (dataStream: string) => string;
+export declare const isEmptyDocument: (dataStream?: string) => boolean;
 export declare const fromPlainText: (text: string) => IDocumentBody;

package/lib/types/docs/data-model/text-x/build-utils/text-x-utils.d.ts

@@ -1,15 +1,18 @@
 import { IAccessor } from '@wendellhu/redi';
-import { TextX } from '../text-x';
 import { Nullable } from '../../../../shared';
 import { ITextRange, ITextRangeParam } from '../../../../sheets/typedef';
 import { CustomRangeType, IDocumentBody } from '../../../../types/interfaces';
 import { DocumentDataModel } from '../../document-data-model';
 import { IDeleteAction, IRetainAction } from '../action-types';
+import { TextX } from '../text-x';
 export interface IDeleteCustomRangeParam {
     rangeId: string;
     segmentId?: string;
     documentDataModel: DocumentDataModel;
     insert?: Nullable<IDocumentBody>;
+    textRange?: {
+        index: number;
+    };
 }
 export declare function deleteCustomRangeTextX(accessor: IAccessor, params: IDeleteCustomRangeParam): false | TextX;
 export interface IAddCustomRangeTextXParam {

package/lib/types/docs/data-model/text-x/utils.d.ts

@@ -1,6 +1,6 @@
-import { UpdateDocsAttributeType } from '../../../shared/command-enum';
 import { ICustomDecoration, IDocumentBody } from '../../../types/interfaces/i-document-data';
 import { IRetainAction } from './action-types';
+import { UpdateDocsAttributeType } from '../../../shared/command-enum';
 export declare enum SliceBodyType {
     copy = 0,
     cut = 1

package/lib/types/index.d.ts

@@ -57,9 +57,8 @@ export { ContextService, IContextService } from './services/context/context.serv
 export { ErrorService, type IError } from './services/error/error.service';
 export { IUniverInstanceService } from './services/instance/instance.service';
 export { UniverInstanceService } from './services/instance/instance.service';
-export { LifecycleStages, OnLifecycle, runOnLifecycle } from './services/lifecycle/lifecycle';
+export { LifecycleStages } from './services/lifecycle/lifecycle';
 export { LifecycleService } from './services/lifecycle/lifecycle.service';
-export { LifecycleInitializerService } from './services/lifecycle/lifecycle.service';
 export { ILocalStorageService } from './services/local-storage/local-storage.service';
 export { LocaleService } from './services/locale/locale.service';
 export { DesktopLogService, ILogService, LogLevel } from './services/log/log.service';
@@ -83,6 +82,7 @@ export { type IUser, UserManagerService } from './services/user-manager/user-man
 export * from './shared';
 export { isBlackColor, isWhiteColor } from './shared/color/color-kit';
 export { cellToRange } from './shared/common';
+export { getIntersectRange } from './shared/range';
 export { nameCharacterCheck } from './shared/name';
 export { fromCallback, takeAfter } from './shared/rxjs';
 export { awaitTime } from './shared/timer';
@@ -110,4 +110,5 @@ export * from './types/interfaces';
 export * from './types/interfaces';
 export type { ICellCustomRender, ICellRenderContext } from './types/interfaces/i-cell-custom-render';
 export type { IDataValidationRule, IDataValidationRuleBase, IDataValidationRuleInfo, IDataValidationRuleOptions, ISheetDataValidationRule } from './types/interfaces/i-data-validation';
+export { type IRTreeItem, RTree } from './shared/r-tree';
 export { Univer } from './univer';

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

@@ -1,4 +1,18 @@
-import { Ctor, DependencyIdentifier } from '../../common/di';
+/**
+ * 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.
+ */
 /**
  * This enum defines multiple lifecycle stages in Univer SDK.
  */
@@ -27,44 +41,3 @@ export declare const LifecycleNameMap: {
     2: string;
     3: string;
 };
-export declare const LifecycleToModules: Map<LifecycleStages, DependencyIdentifier<unknown>[]>;
-/**
- * Register the decorated class to be automatically instantiated when Univer progresses to the certain lifecycle stage.
- *
- * @param lifecycleStage The lifecycle stage to instantiate this class.
- * @param identifier The dependency identifier of the class. Usually, it is the class itself unless you bind this class
- * with another injection identifier.
- *
- * @deprecated This API does not work as expected and will be removed in future versions. Please call
- * `this._injector.get(YourDependency)` in plugins' lifecycle hooks instead.
- *
- * @example
- * // Ignore the `\` below. This is JSDoc's bug.
- * \@OnLifecycle(LifecycleStages.Ready, MyService)
- * class MyService {
- * }
- *
- * @example
- * // Ignore the `\` below. This is JSDoc's bug.
- * \@OnLifecycle(LifecycleStages.Rendered, IMyService)
- * class MyService implements IMyService {
- * }
- */
-export declare function OnLifecycle(lifecycleStage: LifecycleStages, identifier: DependencyIdentifier<unknown>): (_: Ctor<unknown>) => void;
-/**
- * Register a dependency to be automatically instantiated when Univer progresses to the certain lifecycle stage.
- *
- * @param lifecycleStage The lifecycle stage to instantiate this dependency.
- * @param identifier The dependencies' identifier. **Beware** that if the dependency (e.g. a class) is bound to an
- * identifier, you should register the identifier instead of the dependency itself.
- *
- * @deprecated This API does not work as expected and will be removed in future versions. Please call
- * `this._injector.get(YourDependency)` in plugins' lifecycle hooks instead.
- *
- * @example
- * runOnLifecycle(LifecycleStages.Ready, MyService);
- *
- * @example
- * runOnLifecycle(LifecycleStages.Rendered, IMyService);
- */
-export declare function runOnLifecycle(lifecycleStage: LifecycleStages, identifier: DependencyIdentifier<unknown>): void;

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

@@ -1,5 +1,4 @@
 import { Observable } from 'rxjs';
-import { Injector } from '../../common/di';
 import { Disposable } from '../../shared/lifecycle';
 import { ILogService } from '../log/log.service';
 import { LifecycleStages } from './lifecycle';
@@ -25,16 +24,4 @@ export declare class LifecycleService extends Disposable {
     subscribeWithPrevious(): Observable<LifecycleStages>;
     private _reportProgress;
 }
-/**
- * This service is used to initialize modules on a certain lifecycle stage.
- * Refer to `runOnLifecycle` and `OnLifecycle` for more details.
- *
- * @internal
- */
-export declare class LifecycleInitializerService extends Disposable {
-    private readonly _injector;
-    private _seenTokens;
-    constructor(_injector: Injector);
-    initModulesOnStage(stage: LifecycleStages): void;
-}
 export declare function getLifecycleStagesAndBefore(lifecycleStage: LifecycleStages): Observable<LifecycleStages>;

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

@@ -1,6 +1,6 @@
 import { Observable, BehaviorSubject } from 'rxjs';
-import { Disposable } from '../../shared';
 import { IPermissionPoint, IPermissionService } from './type';
+import { Disposable } from '../../shared';
 export declare class PermissionService extends Disposable implements IPermissionService {
     private _permissionPointMap;
     private _permissionPointUpdate$;

package/lib/types/services/permission/type.d.ts

@@ -1,7 +1,7 @@
-import { BehaviorSubject, Observable } from 'rxjs';
 import { UnitAction, UnitObject } from '@univerjs/protocol';
-import { IRange } from '../../sheets/typedef';
+import { BehaviorSubject, Observable } from 'rxjs';
 import { Nullable } from '../../shared/types';
+import { IRange } from '../../sheets/typedef';
 export declare enum PermissionStatus {
     INIT = "init",
     FETCHING = "fetching",

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

@@ -1,6 +1,6 @@
 import { Ctor, Injector } from '../../common/di';
-import { Disposable } from '../../shared';
 import { UniverInstanceType } from '../../common/unit';
+import { Disposable } from '../../shared';
 export declare const DependentOnSymbol: unique symbol;
 export type PluginCtor<T extends Plugin = Plugin> = Ctor<T> & {
     type: UniverInstanceType;
@@ -14,7 +14,7 @@ export declare abstract class Plugin extends Disposable {
     static pluginName: string;
     static type: UniverInstanceType;
     protected abstract _injector: Injector;
-    onStarting(_injector?: Injector): void;
+    onStarting(): void;
     onReady(): void;
     onRendered(): void;
     onSteady(): void;

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

@@ -1,9 +1,9 @@
 import { IDisposable, Injector } from '../../common/di';
-import { Disposable } from '../../shared/lifecycle';
+import { Plugin, PluginCtor, PluginRegistry, PluginStore } from './plugin';
 import { UniverInstanceType } from '../../common/unit';
-import { LifecycleInitializerService, LifecycleService } from '../lifecycle/lifecycle.service';
+import { Disposable } from '../../shared/lifecycle';
+import { LifecycleService } from '../lifecycle/lifecycle.service';
 import { ILogService } from '../log/log.service';
-import { Plugin, PluginCtor, PluginRegistry, PluginStore } from './plugin';
 /**
  * Use this decorator to declare dependencies among plugins. If a dependent plugin is not registered yet,
  * Univer will automatically register it with no configuration.
@@ -45,7 +45,6 @@ export declare class PluginHolder extends Disposable {
     protected readonly _logService: ILogService;
     protected readonly _injector: Injector;
     protected readonly _lifecycleService: LifecycleService;
-    protected readonly _lifecycleInitializerService: LifecycleInitializerService;
     protected _started: boolean;
     get started(): boolean;
     private _warnedAboutOnStartingDeprecation;
@@ -53,8 +52,9 @@ export declare class PluginHolder extends Disposable {
     protected readonly _pluginRegistry: PluginRegistry;
     /** Stores initialized plugin instances. */
     protected readonly _pluginStore: PluginStore;
-    private readonly _awaitingPlugins;
-    constructor(_checkPluginRegistered: (pluginCtor: PluginCtor) => boolean, _registerPlugin: <T extends PluginCtor>(plugin: T, config?: ConstructorParameters<T>[0]) => void, _logService: ILogService, _injector: Injector, _lifecycleService: LifecycleService, _lifecycleInitializerService: LifecycleInitializerService);
+    /** Plugins instances as they are registered in batches. */
+    private readonly _pluginsInBatches;
+    constructor(_checkPluginRegistered: (pluginCtor: PluginCtor) => boolean, _registerPlugin: <T extends PluginCtor>(plugin: T, config?: ConstructorParameters<T>[0]) => void, _logService: ILogService, _injector: Injector, _lifecycleService: LifecycleService);
     dispose(): void;
     register<T extends PluginCtor<Plugin>>(pluginCtor: T, config?: ConstructorParameters<T>[0]): void;
     immediateInitPlugin<T extends Plugin>(plugin: PluginCtor<T>): void;

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

@@ -1,7 +1,7 @@
 import { IResources } from '../resource-manager/type';
+export declare const IResourceLoaderService: import('@wendellhu/redi').IdentifierDecorator<IResourceLoaderService>;
 export interface IResourceLoaderService {
     saveUnit<T = object>(unitId: string): T & {
         resources: IResources;
     } | null;
 }
-export declare const IResourceLoaderService: import('@wendellhu/redi').IdentifierDecorator<IResourceLoaderService>;

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

@@ -1,5 +1,5 @@
-import { Observable } from 'rxjs';
 import { UniverInstanceType } from '@univerjs/core';
+import { Observable } from 'rxjs';
 import { IDisposable } from '../../common/di';
 export type IResources = Array<{
     id?: string;

package/lib/types/shared/r-tree.d.ts

@@ -0,0 +1,29 @@
+import { BBox, default as RBush } from 'rbush';
+import { IUnitRange } from '../sheets/typedef';
+export interface IRTreeItem extends IUnitRange {
+    id: string;
+}
+interface IRBushItem extends BBox {
+    id: string;
+}
+export interface IRTreeData {
+    [unitId: string]: {
+        [subUnitId: string]: IRTreeItem[];
+    };
+}
+export declare class RTree {
+    private _tree;
+    dispose(): void;
+    getTree(unitId: string, subUnitId: string): RBush<IRBushItem>;
+    insert(item: IRTreeItem): void;
+    bulkInsert(items: IRTreeItem[]): void;
+    search(search: IUnitRange): Map<string, IRTreeItem>;
+    bulkSearch(searchList: IUnitRange[]): Map<string, IRTreeItem>;
+    removeById(unitId: string, subUnitId?: string): void;
+    remove(search: IRTreeItem): void;
+    bulkRemove(searchList: IRTreeItem[]): void;
+    clear(): void;
+    toJSON(): IRTreeData;
+    fromJSON(data: IRTreeData): void;
+}
+export {};

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

@@ -1,4 +1,5 @@
 import { IRange } from '../sheets/typedef';
+import { Nullable } from './types';
 export declare function moveRangeByOffset(range: IRange, refOffsetX: number, refOffsetY: number, ignoreAbsolute?: boolean): IRange;
 /**
  * Split ranges into aligned smaller ranges
@@ -25,3 +26,13 @@ export declare function mergeVerticalRanges(ranges: IRange[]): IRange[];
  */
 export declare function mergeRanges(ranges: IRange[]): IRange[];
 export declare function multiSubtractSingleRange(ranges: IRange[], toDelete: IRange): IRange[];
+/**
+ * Computes the intersection of two ranges.
+ * If there is an overlap between the two ranges, returns a new range representing the intersection.
+ * If there is no overlap, returns null.
+ *
+ * @param src - The source range.
+ * @param target - The target range.
+ * @returns The intersected range or null if there is no intersection.
+ */
+export declare function getIntersectRange(src: IRange, target: IRange): Nullable<IRange>;

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

@@ -1,5 +1,5 @@
-import { IRange, IRectLTRB } from '../sheets/typedef';
 import { Nullable } from './types';
+import { IRange, IRectLTRB } from '../sheets/typedef';
 /**
  * This class provides a set of methods to calculate `IRange`.
  */
@@ -15,6 +15,10 @@ export declare class Rectangle {
      */
     static simpleRangesIntersect(rangeA: IRange, rangeB: IRange): boolean;
     static intersects(src: IRange, target: IRange): boolean;
+    /**
+     *
+     * @deprecated use `getIntersectRange` instead. This method does not handle NaN and does not return the correct rangeType
+     */
     static getIntersects(src: IRange, target: IRange): Nullable<IRange>;
     static contains(src: IRange, target: IRange): boolean;
     static realContain(src: IRange, target: IRange): boolean;

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

@@ -1,5 +1,5 @@
-import { ObjectMatrix, IObjectMatrixPrimitiveType, Nullable } from '../shared';
-import { BooleanNumber, FontItalic, FontWeight, WrapStrategy, HorizontalAlign, VerticalAlign } from '../types/enum';
+import { IObjectMatrixPrimitiveType, Nullable, ObjectMatrix } from '../shared';
+import { HorizontalAlign, VerticalAlign, BooleanNumber, FontItalic, FontWeight, WrapStrategy } from '../types/enum';
 import { IBorderData, IDocumentBody, IDocumentData, IStyleBase, IStyleData, ITextDecoration, ITextRotation } from '../types/interfaces';
 import { Styles } from './styles';
 import { ICellData, IRange } from './typedef';

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

@@ -1,5 +1,5 @@
-import { Disposable } from '../shared/lifecycle';
 import { IRange } from './typedef';
+import { Disposable } from '../shared/lifecycle';
 export declare class SpanModel extends Disposable {
     /**
      * @property Cache for RANGE_TYPE.NORMAL
@@ -51,6 +51,13 @@ export declare class SpanModel extends Disposable {
     add(range: IRange): void;
     remove(row: number, column: number): void;
     getMergedCell(row: number, column: number): IRange | null;
+    /**
+     * Return index of merge data if (row,col) is in merge range. -1 means not in merge range.
+     * @param row
+     * @param column
+     * @returns {number} index of merge range.
+     */
+    getMergeDataIndex(row: number, column: number): number;
     isRowContainsMergedCell(row: number): boolean;
     isColumnContainsMergedCell(column: number): boolean;
     getMergedCellRange(startRow: number, startColumn: number, endRow: number, endColumn: number): IRange[];

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

@@ -1,10 +1,10 @@
 import { Observable } from 'rxjs';
+import { Nullable } from '../shared';
+import { IRangeType, IWorkbookData, IWorksheetData } from './typedef';
 import { UnitModel, UniverInstanceType } from '../common/unit';
 import { ILogService } from '../services/log/log.service';
 import { Styles } from './styles';
 import { Worksheet } from './worksheet';
-import { Nullable } from '../shared';
-import { IRangeType, IWorkbookData, IWorksheetData } from './typedef';
 export declare function getWorksheetUID(workbook: Workbook, worksheet: Worksheet): string;
 /**
  * Access and create Univer Sheets files

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

@@ -1,12 +1,12 @@
-import { ObjectMatrix, Nullable } from '../shared';
+import { Nullable, ObjectMatrix } from '../shared';
+import { Styles } from './styles';
+import { ICellData, ICellDataForSheetInterceptor, IFreeze, IRange, ISelectionCell, IWorksheetData } from './typedef';
 import { BooleanNumber } from '../types/enum';
 import { ColumnManager } from './column-manager';
 import { Range } from './range';
 import { RowManager } from './row-manager';
 import { SpanModel } from './span-model';
 import { SheetViewModel } from './view-model';
-import { Styles } from './styles';
-import { ICellData, ICellDataForSheetInterceptor, IFreeze, IRange, ISelectionCell, IWorksheetData } from './typedef';
 /**
  * The model of a Worksheet.
  */
@@ -91,7 +91,7 @@ export declare class Worksheet {
      */
     getMergedCell(row: number, col: number): Nullable<IRange>;
     /**
-     *  Get the merged cell info list which has intersection with the given range.
+     * Get the merged cell info list which has intersection with the given range.
      * @param {number} startRow The start row index of the range
      * @param {number} startColumn The start column index of the range
      * @param {number} endRow The end row index of the range

package/lib/types/types/enum/locale-type.d.ts

@@ -21,5 +21,6 @@ export declare enum LocaleType {
     ZH_CN = "zhCN",
     RU_RU = "ruRU",
     ZH_TW = "zhTW",
-    VI_VN = "viVN"
+    VI_VN = "viVN",
+    FA_IR = "faIR"
 }

package/lib/types/univer.d.ts

@@ -1,7 +1,3 @@
-import { Injector } from './common/di';
-import { DocumentDataModel } from './docs/data-model/document-data-model';
-import { Workbook } from './sheets/workbook';
-import { SlideDataModel } from './slides/slide-model';
 import { UnitModel, UnitType } from './common/unit';
 import { LogLevel } from './services/log/log.service';
 import { Plugin, PluginCtor } from './services/plugin/plugin';
@@ -11,6 +7,10 @@ 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 { Workbook } from './sheets/workbook';
+import { SlideDataModel } from './slides/slide-model';
 export interface IUniverConfig {
     theme: IStyleSheet;
     locale: LocaleType;