@univerjs/engine-formula 0.1.4 → 0.1.6

package/lib/types/services/defined-names.service.d.ts

@@ -1,34 +1,61 @@
-/**
- * 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 type { Nullable } from '@univerjs/core';
-import { Disposable } from '@univerjs/core';
+import { Observable } from 'rxjs';
+import { IUnitRange, Nullable, Disposable } from '@univerjs/core';
+
+export interface IDefinedNamesServiceParam {
+    id: string;
+    name: string;
+    formulaOrRefString: string;
+    comment?: string;
+    localSheetId?: string;
+    hidden?: boolean;
+}
+export interface IDefinedNamesServiceFocusParam extends IDefinedNamesServiceParam {
+    unitId: string;
+}
+export interface IDefinedNameMap {
+    [unitId: string]: IDefinedNameMapItem;
+}
+export interface IDefinedNameMapItem {
+    [id: string]: IDefinedNamesServiceParam;
+}
 export interface IDefinedNamesService {
-    registerDefinedName(unitId: string, name: string, formulaOrRefString: string): void;
-    getDefinedNameMap(unitId: string): Nullable<Map<string, string>>;
-    getValue(unitId: string, name: string): Nullable<string>;
+    registerDefinedName(unitId: string, param: IDefinedNamesServiceParam): void;
+    registerDefinedNames(unitId: string, params: IDefinedNameMapItem): void;
+    getDefinedNameMap(unitId: string): Nullable<IDefinedNameMapItem>;
+    getValueByName(unitId: string, name: string): Nullable<IDefinedNamesServiceParam>;
+    getValueById(unitId: string, id: string): Nullable<IDefinedNamesServiceParam>;
     removeDefinedName(unitId: string, name: string): void;
     hasDefinedName(unitId: string): boolean;
+    setCurrentRange(range: IUnitRange): void;
+    getCurrentRange(): IUnitRange;
+    getCurrentRangeForString(): string;
+    currentRange$: Observable<IUnitRange>;
+    update$: Observable<unknown>;
+    focusRange$: Observable<IDefinedNamesServiceFocusParam>;
+    focusRange(unitId: string, id: string): void;
 }
 export declare class DefinedNamesService extends Disposable implements IDefinedNamesService {
     private _definedNameMap;
+    private readonly _update$;
+    readonly update$: Observable<unknown>;
+    private _currentRange;
+    private readonly _currentRange$;
+    readonly currentRange$: Observable<IUnitRange>;
+    private readonly _focusRange$;
+    readonly focusRange$: Observable<IDefinedNamesServiceFocusParam>;
+    constructor();
     dispose(): void;
-    registerDefinedName(unitId: string, name: string, formulaOrRefString: string): void;
-    removeDefinedName(unitId: string, name: string): void;
-    getDefinedNameMap(unitId: string): Map<string, string> | undefined;
-    getValue(unitId: string, name: string): string | undefined;
+    focusRange(unitId: string, id: string): void;
+    setCurrentRange(range: IUnitRange): void;
+    getCurrentRange(): IUnitRange;
+    getCurrentRangeForString(): string;
+    registerDefinedNames(unitId: string, params: IDefinedNameMapItem): void;
+    registerDefinedName(unitId: string, param: IDefinedNamesServiceParam): void;
+    removeDefinedName(unitId: string, id: string): void;
+    getDefinedNameMap(unitId: string): IDefinedNameMapItem;
+    getValueByName(unitId: string, name: string): IDefinedNamesServiceParam | null;
+    getValueById(unitId: string, id: string): IDefinedNamesServiceParam;
     hasDefinedName(unitId: string): boolean;
+    private _update;
 }
-export declare const IDefinedNamesService: import("@wendellhu/redi").IdentifierDecorator<DefinedNamesService>;
+export declare const IDefinedNamesService: import('@wendellhu/redi').IdentifierDecorator<DefinedNamesService>;

package/lib/types/services/feature-calculation-manager.service.d.ts

@@ -1,22 +1,7 @@
-/**
- * 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 type { IUnitRange, Nullable } from '@univerjs/core';
-import { Disposable } from '@univerjs/core';
-import type { IFeatureDirtyRangeType, IRuntimeUnitDataType } from '../basics/common';
-import type { FormulaDependencyTree } from '../engine/dependency/dependency-tree';
+import { FormulaDependencyTree } from '../engine/dependency/dependency-tree';
+import { IFeatureDirtyRangeType, IRuntimeUnitDataType } from '../basics/common';
+import { IUnitRange, Nullable, Disposable } from '@univerjs/core';
+
 export interface IFeatureCalculationManagerParam {
     unitId: string;
     subUnitId: string;
@@ -49,4 +34,4 @@ export declare class FeatureCalculationManagerService extends Disposable impleme
     register(featureId: string, referenceExecutor: IFeatureCalculationManagerParam): void;
     getReferenceExecutorMap(): Map<string, IFeatureCalculationManagerParam>;
 }
-export declare const IFeatureCalculationManagerService: import("@wendellhu/redi").IdentifierDecorator<FeatureCalculationManagerService>;
+export declare const IFeatureCalculationManagerService: import('@wendellhu/redi').IdentifierDecorator<FeatureCalculationManagerService>;

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

@@ -1,22 +1,7 @@
-/**
- * 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 type { Nullable } from '@univerjs/core';
-import { Disposable } from '@univerjs/core';
-import type { IFunctionInfo, IFunctionNames } from '../basics/function';
-import type { BaseFunction } from '../functions/base-function';
+import { BaseFunction } from '../functions/base-function';
+import { IFunctionInfo, IFunctionNames } from '../basics/function';
+import { Nullable, Disposable } from '@univerjs/core';
+
 export interface IFunctionService {
     /**
      * Use register to register a function, new CustomFunction(inject, name)
@@ -57,4 +42,4 @@ export declare class FunctionService extends Disposable implements IFunctionServ
     hasDescription(functionToken: IFunctionNames): boolean;
     unregisterDescriptions(...functionTokens: IFunctionNames[]): void;
 }
-export declare const IFunctionService: import("@wendellhu/redi").IdentifierDecorator<FunctionService>;
+export declare const IFunctionService: import('@wendellhu/redi').IdentifierDecorator<FunctionService>;

package/lib/types/services/other-formula-manager.service.d.ts

@@ -1,21 +1,6 @@
-/**
- * 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 type { Nullable } from '@univerjs/core';
-import { Disposable } from '@univerjs/core';
-import type { IFormulaDataItem, IOtherFormulaData } from '../basics/common';
+import { IDirtyUnitOtherFormulaMap, IFormulaDataItem, IOtherFormulaData } from '../basics/common';
+import { Nullable, Disposable } from '@univerjs/core';
+
 export interface IOtherFormulaManagerSearchParam {
     unitId: string;
     subUnitId: string;
@@ -31,6 +16,8 @@ export interface IOtherFormulaManagerService {
     has(searchParam: IOtherFormulaManagerSearchParam): boolean;
     register(insertParam: IOtherFormulaManagerInsertParam): void;
     getOtherFormulaData(): IOtherFormulaData;
+    batchRegister(formulaData: IOtherFormulaData): void;
+    batchRemove(formulaData: IDirtyUnitOtherFormulaMap): void;
 }
 /**
  * Passively marked as dirty, register the reference and execution actions of the feature plugin.
@@ -45,6 +32,8 @@ export declare class OtherFormulaManagerService extends Disposable implements IO
     get(searchParam: IOtherFormulaManagerSearchParam): IFormulaDataItem | undefined;
     has(searchParam: IOtherFormulaManagerSearchParam): boolean;
     register(insertParam: IOtherFormulaManagerInsertParam): void;
+    batchRegister(formulaData: IOtherFormulaData): void;
+    batchRemove(formulaData: IDirtyUnitOtherFormulaMap): void;
     getOtherFormulaData(): IOtherFormulaData;
 }
-export declare const IOtherFormulaManagerService: import("@wendellhu/redi").IdentifierDecorator<OtherFormulaManagerService>;
+export declare const IOtherFormulaManagerService: import('@wendellhu/redi').IdentifierDecorator<OtherFormulaManagerService>;

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

@@ -1,24 +1,9 @@
-/**
- * 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 type { Nullable } from '@univerjs/core';
-import { Disposable } from '@univerjs/core';
-import type { IArrayFormulaRangeType, IFeatureDirtyRangeType, INumfmtItemMap, IRuntimeOtherUnitDataType, IRuntimeUnitDataType } from '../basics/common';
-import type { BaseAstNode } from '../engine/ast-node/base-ast-node';
-import type { FunctionVariantType } from '../engine/reference-object/base-reference-object';
 import { IFormulaCurrentConfigService } from './current-data.service';
+import { FunctionVariantType } from '../engine/reference-object/base-reference-object';
+import { BaseAstNode } from '../engine/ast-node/base-ast-node';
+import { IArrayFormulaRangeType, IFeatureDirtyRangeType, INumfmtItemMap, IRuntimeOtherUnitDataType, IRuntimeUnitDataType } from '../basics/common';
+import { Nullable, Disposable } from '@univerjs/core';
+
 /**
  * IDLE: Idle phase of the formula engine.
  *
@@ -193,4 +178,4 @@ export declare class FormulaRuntimeService extends Disposable implements IFormul
     private _checkIfArrayFormulaExceeded;
     private _isInDirtyRange;
 }
-export declare const IFormulaRuntimeService: import("@wendellhu/redi").IdentifierDecorator<FormulaRuntimeService>;
+export declare const IFormulaRuntimeService: import('@wendellhu/redi').IdentifierDecorator<FormulaRuntimeService>;

package/lib/types/services/super-table.service.d.ts

@@ -1,21 +1,6 @@
-/**
- * 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 type { Nullable } from '@univerjs/core';
-import { Disposable } from '@univerjs/core';
-import type { ISuperTable, TableOptionType } from '../basics/common';
+import { ISuperTable, TableOptionType } from '../basics/common';
+import { Nullable, Disposable } from '@univerjs/core';
+
 export interface ISuperTableOptionParam {
     tableOption: string;
     tableOptionType: TableOptionType;
@@ -37,4 +22,4 @@ export declare class SuperTableService extends Disposable implements ISuperTable
     registerTable(unitId: string, tableName: string, reference: ISuperTable): void;
     registerTableOptionMap(tableOption: string, tableOptionType: TableOptionType): void;
 }
-export declare const ISuperTableService: import("@wendellhu/redi").IdentifierDecorator<ISuperTableService>;
+export declare const ISuperTableService: import('@wendellhu/redi').IdentifierDecorator<ISuperTableService>;