@univerjs/sheets-formula 0.3.0 → 0.4.0-alpha.0

package/lib/types/common/plugin-name.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const FORMULA_UI_PLUGIN_NAME = "SHEET_FORMULA_UI_PLUGIN";
+export declare const SHEETS_FORMULA_PLUGIN_NAME = "SHEETS_FORMULA_PLUGIN";

package/lib/types/controllers/active-dirty.controller.d.ts

@@ -1,11 +1,10 @@
 import { Disposable, IUniverInstanceService } from '@univerjs/core';
-import { FormulaDataModel, IActiveDirtyManagerService, IDefinedNamesService } from '@univerjs/engine-formula';
+import { FormulaDataModel, IActiveDirtyManagerService } from '@univerjs/engine-formula';
 export declare class ActiveDirtyController extends Disposable {
     private readonly _activeDirtyManagerService;
     private readonly _univerInstanceService;
     private readonly _formulaDataModel;
-    private readonly _definedNamesService;
-    constructor(_activeDirtyManagerService: IActiveDirtyManagerService, _univerInstanceService: IUniverInstanceService, _formulaDataModel: FormulaDataModel, _definedNamesService: IDefinedNamesService);
+    constructor(_activeDirtyManagerService: IActiveDirtyManagerService, _univerInstanceService: IUniverInstanceService, _formulaDataModel: FormulaDataModel);
     private _initialize;
     private _initialConversion;
     private _initialMove;

package/lib/types/controllers/{array-formula-display.controller.d.ts → array-formula-cell-interceptor.controller.d.ts}

@@ -1,12 +1,11 @@
-import { Disposable, ICommandService, ThemeService } from '@univerjs/core';
+import { Disposable, ICommandService } from '@univerjs/core';
 import { FormulaDataModel } from '@univerjs/engine-formula';
 import { SheetInterceptorService } from '@univerjs/sheets';
-export declare class ArrayFormulaDisplayController extends Disposable {
+export declare class ArrayFormulaCellInterceptorController extends Disposable {
     private readonly _commandService;
     private _sheetInterceptorService;
     private readonly _formulaDataModel;
-    private readonly _themeService;
-    constructor(_commandService: ICommandService, _sheetInterceptorService: SheetInterceptorService, _formulaDataModel: FormulaDataModel, _themeService: ThemeService);
+    constructor(_commandService: ICommandService, _sheetInterceptorService: SheetInterceptorService, _formulaDataModel: FormulaDataModel);
     private _initialize;
     private _commandExecutedListener;
     private _initInterceptorCellContent;

package/lib/types/controllers/config.schema.d.ts

@@ -1,13 +1,11 @@
-import { MenuConfig } from '@univerjs/ui';
-import { BaseFunction, IFunctionInfo, IFunctionNames } from '@univerjs/engine-formula';
 import { Ctor } from '@univerjs/core';
+import { BaseFunction, IFunctionInfo, IFunctionNames } from '@univerjs/engine-formula';
 /**
  * Base configuration for the plugin.
  */
 export declare const PLUGIN_CONFIG_KEY_BASE = "sheets-formula.base.config";
 export declare const configSymbolBase: unique symbol;
 export interface IUniverSheetsFormulaBaseConfig {
-    menu?: MenuConfig;
     notExecuteFormula?: boolean;
     description?: IFunctionInfo[];
     function?: Array<[Ctor<BaseFunction>, IFunctionNames]>;
@@ -26,7 +24,3 @@ export declare const defaultPluginRemoteConfig: IUniverSheetsFormulaRemoteConfig
  */
 export declare const PLUGIN_CONFIG_KEY_MOBILE = "sheets-formula.mobile.config";
 export declare const configSymbolMobile: unique symbol;
-export interface IUniverSheetsFormulaMobileConfig {
-    menu?: MenuConfig;
-}
-export declare const defaultPluginMobileConfig: IUniverSheetsFormulaMobileConfig;

package/lib/types/controllers/formula.controller.d.ts

@@ -0,0 +1,5 @@
+import { Disposable, ICommandService } from '@univerjs/core';
+export declare class FormulaController extends Disposable {
+    private readonly _commandService;
+    constructor(_commandService: ICommandService);
+}

package/lib/types/controllers/trigger-calculation.controller.d.ts

@@ -1,13 +1,16 @@
 import { Disposable, ICommandService } from '@univerjs/core';
-import { FormulaDataModel, IActiveDirtyManagerService } from '@univerjs/engine-formula';
-import { INumfmtService } from '@univerjs/sheets';
-import { IProgressService } from '@univerjs/ui';
+import { IActiveDirtyManagerService } from '@univerjs/engine-formula';
+/**
+ * This interface is for the progress bar to display the calculation progress.
+ */
+export interface ICalculationProgress {
+    done: number;
+    /** The total number of formulas need to calculate. */
+    count: number;
+}
 export declare class TriggerCalculationController extends Disposable {
     private readonly _commandService;
     private readonly _activeDirtyManagerService;
-    private readonly _numfmtService;
-    private readonly _formulaDataModel;
-    private readonly _progressService;
     private _waitingCommandQueue;
     private _executingDirtyData;
     private _setTimeoutKey;
@@ -16,8 +19,10 @@ export declare class TriggerCalculationController extends Disposable {
     private _arrayFormulaCalculationDoneCount;
     private _executionInProgressParams;
     private _restartCalculation;
-    constructor(_commandService: ICommandService, _activeDirtyManagerService: IActiveDirtyManagerService, _numfmtService: INumfmtService, _formulaDataModel: FormulaDataModel, _progressService: IProgressService);
-    private _initialize;
+    private readonly _progress$;
+    readonly progress$: import('rxjs').Observable<ICalculationProgress>;
+    constructor(_commandService: ICommandService, _activeDirtyManagerService: IActiveDirtyManagerService);
+    dispose(): void;
     private _commandExecutedListener;
     private _generateDirty;
     private _mergeDirty;

package/lib/types/controllers/update-defined-name.controller.d.ts

@@ -0,0 +1,14 @@
+import { Disposable, IUniverInstanceService } from '@univerjs/core';
+import { IDefinedNamesService, LexerTreeBuilder } from '@univerjs/engine-formula';
+import { SheetInterceptorService } from '@univerjs/sheets';
+export declare class UpdateDefinedNameController extends Disposable {
+    private readonly _definedNamesService;
+    private readonly _univerInstanceService;
+    private _sheetInterceptorService;
+    private readonly _lexerTreeBuilder;
+    constructor(_definedNamesService: IDefinedNamesService, _univerInstanceService: IUniverInstanceService, _sheetInterceptorService: SheetInterceptorService, _lexerTreeBuilder: LexerTreeBuilder);
+    private _initialize;
+    private _commandExecutedListener;
+    private _getUpdateDefinedNameMutations;
+    private _removeSheet;
+}

package/lib/types/controllers/update-formula.controller.d.ts

@@ -1,17 +1,16 @@
 import { Disposable, ICommandService, Injector, IUniverInstanceService } from '@univerjs/core';
-import { IEditorService } from '@univerjs/docs-ui';
-import { FormulaDataModel, LexerTreeBuilder } from '@univerjs/engine-formula';
-import { SheetInterceptorService, SheetsSelectionsService } from '@univerjs/sheets';
+import { FormulaDataModel, IDefinedNamesService, LexerTreeBuilder } from '@univerjs/engine-formula';
+import { SheetInterceptorService } from '@univerjs/sheets';
 /**
  * Update formula process
  *
  * 1. Command intercepts, converts the command information to adapt refRange, offsets the formula content, and obtains the formula that requires offset content.
  *
-   2. Use refRange to offset the formula position and return undo/redo data to setRangeValues mutation
-        - Redo data: Delete the old value at the old position on the match, and add the new value at the new position (the new value first checks whether the old position has offset content, if so, use the new offset content, if not, take the old value)
-        - Undo data: the old position on the match saves the old value, and the new position delete value. Using undos when undoing will operate the data after the offset position.
-
-   3. onCommandExecuted, before formula calculation, use the setRangeValues information to delete the old formulaData, ArrayFormula and ArrayFormulaCellData, and send the worker (complementary setRangeValues after collaborative conflicts, normal operation triggers formula update, undo/redo are captured and processed here)
+ * 2. Use refRange to offset the formula position and return undo/redo data to setRangeValues mutation
+ *      - Redo data: Delete the old value at the old position on the match, and add the new value at the new position (the new value first checks whether the old position has offset content, if so, use the new offset content, if not, take the old value)
+ *      - Undo data: the old position on the match saves the old value, and the new position delete value. Using undos when undoing will operate the data after the offset position.
+ *
+ * 3. onCommandExecuted, before formula calculation, use the setRangeValues information to delete the old formulaData, ArrayFormula and ArrayFormulaCellData, and send the worker (complementary setRangeValues after collaborative conflicts, normal operation triggers formula update, undo/redo are captured and processed here)
  */
 export declare class UpdateFormulaController extends Disposable {
     private readonly _univerInstanceService;
@@ -19,54 +18,14 @@ export declare class UpdateFormulaController extends Disposable {
     private readonly _lexerTreeBuilder;
     private readonly _formulaDataModel;
     private _sheetInterceptorService;
-    private _selectionManagerService;
-    private readonly _editorService;
+    private readonly _definedNamesService;
     readonly _injector: Injector;
-    constructor(_univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _lexerTreeBuilder: LexerTreeBuilder, _formulaDataModel: FormulaDataModel, _sheetInterceptorService: SheetInterceptorService, _selectionManagerService: SheetsSelectionsService, _editorService: IEditorService, _injector: Injector);
-    private _initialize;
+    constructor(_univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _lexerTreeBuilder: LexerTreeBuilder, _formulaDataModel: FormulaDataModel, _sheetInterceptorService: SheetInterceptorService, _definedNamesService: IDefinedNamesService, _injector: Injector);
     private _commandExecutedListener;
     private _handleSetRangeValuesMutation;
-    private _handleRemoveSheetMutation;
+    private _handleWorkbookDisposed;
     private _handleInsertSheetMutation;
-    private _handleUnitAdded;
+    private _handleWorkbookAdded;
     private _getUpdateFormula;
-    private _handleMoveRange;
-    private _handleMoveRows;
-    private _handleMoveCols;
-    private _handleInsertRow;
-    private _handleInsertCol;
-    private _handleInsertRangeMoveRight;
-    private _handleInsertRangeMoveDown;
-    private _handleRemoveRow;
-    private _handleRemoveCol;
-    private _handleDeleteRangeMoveUp;
-    private _handleDeleteRangeMoveLeft;
-    private _handleSetWorksheetName;
-    private _handleRemoveWorksheet;
     private _getFormulaReferenceMoveInfo;
-    private _getNewRangeByMoveParam;
-    private _checkIsSameUnitAndSheet;
-    /**
-     * Update all ref nodes to the latest offset state.
-     */
-    private _updateRefOffset;
-    /**
-     * Determine the range of the moving selection,
-     * and check if it is at the edge of the reference range of the formula.
-     * @param originRange
-     * @param fromRange
-     */
-    private _checkMoveEdge;
-    /**
-     *  Calculate the new ref information for the moving selection.
-     * @param moveEdge  the 'from' range lie on the edge of the original range, or does it completely cover the original range
-     * @param result The original range is divided by 'from' and moved to a new position range.
-     * @param from The initial range of the moving selection.
-     * @param to The result range after moving the initial range.
-     * @param origin The original target range.
-     * @param remain "The range subtracted from the initial range by 'from'.
-     * @returns
-     */
-    private _getMoveNewRange;
-    private _getCurrentSheetInfo;
 }

package/lib/types/controllers/utils/ref-range-formula.d.ts

@@ -1,5 +1,5 @@
 import { ICellData, IMutationInfo, IObjectMatrixPrimitiveType, IRange, Nullable } from '@univerjs/core';
-import { IFormulaData, IFormulaDataItem } from '@univerjs/engine-formula';
+import { IFormulaData, IFormulaDataItem, ISequenceNode } from '@univerjs/engine-formula';
 export declare enum FormulaReferenceMoveType {
     MoveRange = 0,// range
     MoveRows = 1,// move rows
@@ -13,7 +13,9 @@ export declare enum FormulaReferenceMoveType {
     InsertMoveDown = 9,// range
     InsertMoveRight = 10,// range
     SetName = 11,
-    RemoveSheet = 12
+    RemoveSheet = 12,
+    SetDefinedName = 13,// update defined name
+    RemoveDefinedName = 14
 }
 export interface IFormulaReferenceMoveParam {
     type: FormulaReferenceMoveType;
@@ -23,6 +25,8 @@ export interface IFormulaReferenceMoveParam {
     from?: IRange;
     to?: IRange;
     sheetName?: string;
+    definedNameId?: string;
+    definedName?: string;
 }
 export declare function getFormulaReferenceMoveUndoRedo(oldFormulaData: IFormulaData, newFormulaData: IFormulaData, formulaReferenceMoveParam: IFormulaReferenceMoveParam): {
     undos: IMutationInfo<object>[];
@@ -69,3 +73,5 @@ export declare function formulaDataItemToCellData(formulaDataItem: Nullable<IFor
  */
 export declare function formulaDataToCellData(formulaData: IObjectMatrixPrimitiveType<IFormulaDataItem | null>): IObjectMatrixPrimitiveType<Nullable<ICellData>>;
 export declare function isFormulaDataItem(cell: IFormulaDataItem): boolean;
+export declare function checkIsSameUnitAndSheet(userUnitId: string, userSheetId: string, currentFormulaUnitId: string, currentFormulaSheetId: string, sequenceRangeUnitId: string, sequenceRangeSheetId: string): boolean;
+export declare function updateRefOffset(sequenceNodes: Array<string | ISequenceNode>, refChangeIds: number[], refOffsetX?: number, refOffsetY?: number): (string | ISequenceNode)[];

package/lib/types/controllers/utils/ref-range-move.d.ts

@@ -0,0 +1,22 @@
+import { IRange, IUnitRange, Nullable } from '@univerjs/core';
+import { IFormulaReferenceMoveParam } from './ref-range-formula';
+export interface IUnitRangeWithOffset extends IUnitRange {
+    refOffsetX: number;
+    refOffsetY: number;
+    sheetName: string;
+}
+export declare enum OriginRangeEdgeType {
+    UP = 0,
+    DOWN = 1,
+    LEFT = 2,
+    RIGHT = 3,
+    ALL = 4
+}
+export declare function getNewRangeByMoveParam(unitRangeWidthOffset: IUnitRangeWithOffset, formulaReferenceMoveParam: IFormulaReferenceMoveParam, currentFormulaUnitId: string, currentFormulaSheetId: string): string | undefined;
+/**
+ * Determine the range of the moving selection,
+ * and check if it is at the edge of the reference range of the formula.
+ * @param originRange
+ * @param fromRange
+ */
+export declare function checkMoveEdge(originRange: IRange, fromRange: IRange): Nullable<OriginRangeEdgeType>;

package/lib/types/controllers/utils/ref-range-param.d.ts

@@ -0,0 +1,3 @@
+import { ICommandInfo, Nullable, Workbook } from '@univerjs/core';
+import { IFormulaReferenceMoveParam } from './ref-range-formula';
+export declare function getReferenceMoveParams(workbook: Workbook, command: ICommandInfo): Nullable<IFormulaReferenceMoveParam>;

package/lib/types/index.d.ts

@@ -13,23 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { UniverRemoteSheetsFormulaPlugin, UniverSheetsFormulaMobilePlugin, UniverSheetsFormulaPlugin } from './formula-ui-plugin';
-export { IDescriptionService } from './services/description.service';
-export { DescriptionService } from './services/description.service';
+export { type IInsertFunction, type IInsertFunctionCommandParams, InsertFunctionCommand } from './commands/commands/insert-function.command';
+export { OtherFormulaMarkDirty } from './commands/mutations/formula.mutation';
+export { UpdateDefinedNameController } from './controllers/update-defined-name.controller';
+export { UpdateFormulaController } from './controllers/update-formula.controller';
+export { DescriptionService, IDescriptionService, type ISearchItem } from './services/description.service';
+export type { IFormulaInfo, IOtherFormulaResult } from './services/formula-common';
+export { FormulaRefRangeService } from './services/formula-ref-range.service';
 export type { IRegisterFunctionParams, IUnregisterFunctionParams } from './services/register-function.service';
 export { RegisterFunctionService } from './services/register-function.service';
 export { IRegisterFunctionService } from './services/register-function.service';
-export { IRemoteRegisterFunctionService, RemoteRegisterFunctionService } from './services/remote/remote-register-function.service';
-export { FormulaRefRangeService } from './services/formula-ref-range.service';
-export { FORMULA_PROMPT_ACTIVATED } from './services/prompt.service';
 export { RegisterOtherFormulaService } from './services/register-other-formula.service';
-export type { IFormulaInfo, IOtherFormulaResult } from './services/formula-common';
-export { SheetOnlyPasteFormulaCommand } from './commands/commands/formula-clipboard.command';
-export { InsertFunctionCommand } from './commands/commands/insert-function.command';
-export { OtherFormulaMarkDirty } from './commands/mutations/formula.mutation';
-export { SelectEditorFormulaOperation } from './commands/operations/editor-formula.operation';
-export { HelpFunctionOperation } from './commands/operations/help-function.operation';
-export { InsertFunctionOperation } from './commands/operations/insert-function.operation';
-export { MoreFunctionsOperation } from './commands/operations/more-functions.operation';
-export { ReferenceAbsoluteOperation } from './commands/operations/reference-absolute.operation';
-export { SearchFunctionOperation } from './commands/operations/search-function.operation';
+export { IRemoteRegisterFunctionService, RemoteRegisterFunctionService } from './services/remote/remote-register-function.service';
+export { UniverRemoteSheetsFormulaPlugin, UniverSheetsFormulaPlugin } from './sheets-formula.plugin';

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

@@ -1,4 +1,4 @@
-import { IConfigService, LocaleService, IDisposable } from '@univerjs/core';
+import { IDisposable, IConfigService, LocaleService } from '@univerjs/core';
 import { IFunctionInfo, IFunctionNames, IFunctionService } from '@univerjs/engine-formula';
 export interface ISearchItem {
     name: string;

package/lib/types/sheets-formula.plugin.d.ts

@@ -0,0 +1,22 @@
+import { IUniverSheetsFormulaBaseConfig, IUniverSheetsFormulaRemoteConfig } from './controllers/config.schema';
+import { IConfigService, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
+export declare class UniverRemoteSheetsFormulaPlugin extends Plugin {
+    private readonly _config;
+    readonly _injector: Injector;
+    private readonly _configService;
+    static pluginName: string;
+    static type: UniverInstanceType;
+    constructor(_config: Partial<IUniverSheetsFormulaRemoteConfig> | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+}
+export declare class UniverSheetsFormulaPlugin extends Plugin {
+    private readonly _config;
+    readonly _injector: Injector;
+    private readonly _configService;
+    static pluginName: string;
+    static type: UniverInstanceType;
+    constructor(_config: Partial<IUniverSheetsFormulaBaseConfig> | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onReady(): void;
+    onRendered(): void;
+}