@univerjs/sheets-formula 0.20.1 → 0.21.0-insiders.20260424-262d69f

package/lib/cjs/facade.js

@@ -1 +1,252 @@
-let e=require(`@univerjs/core`),t=require(`@univerjs/core/facade`),n=require(`@univerjs/engine-formula`),r=require(`@univerjs/sheets-formula`),i=require(`@univerjs/engine-formula/facade`),a=require(`@univerjs/sheets`),o=require(`@univerjs/sheets/facade`);var s=class extends t.FUniver{_initialize(){this._debouncedFormulaCalculation=(0,e.debounce)(()=>{this._commandService.executeCommand(n.SetTriggerFormulaCalculationStartMutation.id,{commands:[],forceCalculation:!0},{onlyLocal:!0})},10)}registerFunction(e){let t=this._injector.get(r.IRegisterFunctionService);t||(this._injector.add([r.IRegisterFunctionService,{useClass:r.RegisterFunctionService}]),t=this._injector.get(r.IRegisterFunctionService));let n=t.registerFunctions(e);return this._debouncedFormulaCalculation(),n}};t.FUniver.extend(s);var c=class extends i.FFormula{_initialize(){this._debouncedFormulaCalculation=(0,e.debounce)(()=>{this._commandService.executeCommand(n.SetTriggerFormulaCalculationStartMutation.id,{commands:[],forceCalculation:!0},{onlyLocal:!0})},10)}setInitialFormulaComputing(t){let n=this._injector.get(e.LifecycleService).stage,i=this._injector.get(e.ILogService),a=this._injector.get(e.IConfigService);n>e.LifecycleStages.Starting&&i.warn(`[FFormula]`,`CalculationMode is called after the Starting lifecycle and will take effect the next time the Univer Sheet is constructed. If you want it to take effect when the Univer Sheet is initialized this time, consider calling it before the Ready lifecycle or using configuration.`);let o=a.getConfig(r.PLUGIN_CONFIG_KEY_BASE);if(!o){a.setConfig(r.PLUGIN_CONFIG_KEY_BASE,{initialFormulaComputing:t});return}o.initialFormulaComputing=t}registerFunction(e,t,n){var i;let a=this._injector.get(r.IRegisterFunctionService);a||(this._injector.add([r.IRegisterFunctionService,{useClass:r.RegisterFunctionService}]),a=this._injector.get(r.IRegisterFunctionService));let o={name:e,func:t,description:typeof n==`string`?n:(i=n==null?void 0:n.description)==null?``:i,locales:typeof n==`object`?n.locales:void 0},s=a.registerFunction(o);return this._debouncedFormulaCalculation(),s}registerAsyncFunction(e,t,n){var i;let a=this._injector.get(r.IRegisterFunctionService);a||(this._injector.add([r.IRegisterFunctionService,{useClass:r.RegisterFunctionService}]),a=this._injector.get(r.IRegisterFunctionService));let o={name:e,func:t,description:typeof n==`string`?n:(i=n==null?void 0:n.description)==null?``:i,locales:typeof n==`object`?n.locales:void 0},s=a.registerAsyncFunction(o);return this._debouncedFormulaCalculation(),s}calculationResultApplied(e){let t=!1,r=!1,i=null;return this._commandService.onCommandExecuted((o,s)=>{o.id!==n.SetFormulaCalculationResultMutation.id&&o.id!==a.SetRangeValuesMutation.id||(o.id===n.SetFormulaCalculationResultMutation.id&&(t=!0,i=o.params),o.id===a.SetRangeValuesMutation.id&&s!=null&&s.applyFormulaCalculationResult&&(r=!0),!(!t||!r)&&requestIdleCallback(()=>{e(i)}))})}onCalculationResultApplied(){return new Promise((e,t)=>{let r=!1,i=!1,a=setTimeout(()=>{l(),t(Error(`Calculation end timeout`))},6e4),o=setTimeout(()=>{r||(l(),e())},500),s=this.calculationProcessing(t=>{let{stage:i,totalArrayFormulasToCalculate:a,totalFormulasToCalculate:s}=t;if(i===n.FormulaExecuteStageType.START_CALCULATION&&a+s===0){l(),e();return}r||(r=!0,clearTimeout(o))}),c=this.calculationResultApplied(()=>{i||(i=!0,l(),e())});function l(){clearTimeout(a),clearTimeout(o),s.dispose(),c.dispose()}})}};i.FFormula.extend(c);var l=class extends t.FEnum{get CalculationMode(){return r.CalculationMode}};t.FEnum.extend(l);var u=class extends o.FWorkbook{getAllFormulaError(){let e=[],t=this._workbook,r=t.getUnitId(),i=t.getSheets(),a=this._injector.get(n.FormulaDataModel).getArrayFormulaCellData();return i.forEach(t=>{var i;let o=t.getName(),s=t.getSheetId(),c=t.getCellMatrix(),l=(a==null||(i=a[r])==null?void 0:i[s])||{};c.forValue((t,r,i)=>{var a;if(!i)return;let s=(0,n.extractFormulaError)(i,!!(!(l==null||(a=l[t])==null)&&a[r]));s&&e.push({sheetName:o,row:t,column:r,formula:i.f||``,errorType:s})})}),e}};o.FWorkbook.extend(u);var d=class extends o.FRange{getFormulaError(){var e;let t=[],r=this._workbook.getUnitId(),i=this._worksheet.getSheetId(),a=this._worksheet.getName(),o=this._workbook.getSheetBySheetId(i);if(!o)return t;let s=this._injector.get(n.FormulaDataModel).getArrayFormulaCellData(),c=(s==null||(e=s[r])==null?void 0:e[i])||{},l=o.getCellMatrix(),{startRow:u,endRow:d,startColumn:f,endColumn:p}=this._range;for(let e=u;e<=d;e++)for(let r=f;r<=p;r++){var m;let i=l.getValue(e,r);if(!i)continue;let o=(0,n.extractFormulaError)(i,!!(!(c==null||(m=c[e])==null)&&m[r]));o&&t.push({sheetName:a,row:e,column:r,formula:i.f||``,errorType:o})}return t}};o.FRange.extend(d);
+let _univerjs_core = require("@univerjs/core");
+let _univerjs_core_facade = require("@univerjs/core/facade");
+let _univerjs_engine_formula = require("@univerjs/engine-formula");
+let _univerjs_sheets_formula = require("@univerjs/sheets-formula");
+let _univerjs_engine_formula_facade = require("@univerjs/engine-formula/facade");
+let _univerjs_sheets = require("@univerjs/sheets");
+let _univerjs_sheets_facade = require("@univerjs/sheets/facade");
+
+//#region src/facade/f-univer.ts
+/**
+* @ignore
+*/
+var FUniverSheetsFormulaMixin = class extends _univerjs_core_facade.FUniver {
+	/**
+	* Initialize the FUniver instance.
+	* @ignore
+	*/
+	_initialize() {
+		this._debouncedFormulaCalculation = (0, _univerjs_core.debounce)(() => {
+			this._commandService.executeCommand(_univerjs_engine_formula.SetTriggerFormulaCalculationStartMutation.id, {
+				commands: [],
+				forceCalculation: true
+			}, { onlyLocal: true });
+		}, 10);
+	}
+	registerFunction(config) {
+		let registerFunctionService = this._injector.get(_univerjs_sheets_formula.IRegisterFunctionService);
+		if (!registerFunctionService) {
+			this._injector.add([_univerjs_sheets_formula.IRegisterFunctionService, { useClass: _univerjs_sheets_formula.RegisterFunctionService }]);
+			registerFunctionService = this._injector.get(_univerjs_sheets_formula.IRegisterFunctionService);
+		}
+		const functionsDisposable = registerFunctionService.registerFunctions(config);
+		this._debouncedFormulaCalculation();
+		return functionsDisposable;
+	}
+};
+_univerjs_core_facade.FUniver.extend(FUniverSheetsFormulaMixin);
+
+//#endregion
+//#region src/facade/f-formula.ts
+var FFormulaSheetsMixin = class extends _univerjs_engine_formula_facade.FFormula {
+	/**
+	* Initialize the FUniver instance.
+	* @ignore
+	*/
+	_initialize() {
+		this._debouncedFormulaCalculation = (0, _univerjs_core.debounce)(() => {
+			this._commandService.executeCommand(_univerjs_engine_formula.SetTriggerFormulaCalculationStartMutation.id, {
+				commands: [],
+				forceCalculation: true
+			}, { onlyLocal: true });
+		}, 10);
+	}
+	setInitialFormulaComputing(calculationMode) {
+		const lifecycleStage = this._injector.get(_univerjs_core.LifecycleService).stage;
+		const logService = this._injector.get(_univerjs_core.ILogService);
+		const configService = this._injector.get(_univerjs_core.IConfigService);
+		if (lifecycleStage > _univerjs_core.LifecycleStages.Starting) logService.warn("[FFormula]", "CalculationMode is called after the Starting lifecycle and will take effect the next time the Univer Sheet is constructed. If you want it to take effect when the Univer Sheet is initialized this time, consider calling it before the Ready lifecycle or using configuration.");
+		const config = configService.getConfig(_univerjs_sheets_formula.PLUGIN_CONFIG_KEY_BASE);
+		if (!config) {
+			configService.setConfig(_univerjs_sheets_formula.PLUGIN_CONFIG_KEY_BASE, { initialFormulaComputing: calculationMode });
+			return;
+		}
+		config.initialFormulaComputing = calculationMode;
+	}
+	registerFunction(name, func, options) {
+		var _options$description;
+		let registerFunctionService = this._injector.get(_univerjs_sheets_formula.IRegisterFunctionService);
+		if (!registerFunctionService) {
+			this._injector.add([_univerjs_sheets_formula.IRegisterFunctionService, { useClass: _univerjs_sheets_formula.RegisterFunctionService }]);
+			registerFunctionService = this._injector.get(_univerjs_sheets_formula.IRegisterFunctionService);
+		}
+		const params = {
+			name,
+			func,
+			description: typeof options === "string" ? options : (_options$description = options === null || options === void 0 ? void 0 : options.description) !== null && _options$description !== void 0 ? _options$description : "",
+			locales: typeof options === "object" ? options.locales : void 0
+		};
+		const functionsDisposable = registerFunctionService.registerFunction(params);
+		this._debouncedFormulaCalculation();
+		return functionsDisposable;
+	}
+	registerAsyncFunction(name, func, options) {
+		var _options$description2;
+		let registerFunctionService = this._injector.get(_univerjs_sheets_formula.IRegisterFunctionService);
+		if (!registerFunctionService) {
+			this._injector.add([_univerjs_sheets_formula.IRegisterFunctionService, { useClass: _univerjs_sheets_formula.RegisterFunctionService }]);
+			registerFunctionService = this._injector.get(_univerjs_sheets_formula.IRegisterFunctionService);
+		}
+		const params = {
+			name,
+			func,
+			description: typeof options === "string" ? options : (_options$description2 = options === null || options === void 0 ? void 0 : options.description) !== null && _options$description2 !== void 0 ? _options$description2 : "",
+			locales: typeof options === "object" ? options.locales : void 0
+		};
+		const functionsDisposable = registerFunctionService.registerAsyncFunction(params);
+		this._debouncedFormulaCalculation();
+		return functionsDisposable;
+	}
+	calculationResultApplied(callback) {
+		let setFormulaCalculationResult = false;
+		let applyFormulaCalculationResult = false;
+		let result = null;
+		return this._commandService.onCommandExecuted((command, options) => {
+			if (command.id !== _univerjs_engine_formula.SetFormulaCalculationResultMutation.id && command.id !== _univerjs_sheets.SetRangeValuesMutation.id) return;
+			if (command.id === _univerjs_engine_formula.SetFormulaCalculationResultMutation.id) {
+				setFormulaCalculationResult = true;
+				result = command.params;
+			}
+			if (command.id === _univerjs_sheets.SetRangeValuesMutation.id && (options === null || options === void 0 ? void 0 : options.applyFormulaCalculationResult)) applyFormulaCalculationResult = true;
+			if (!setFormulaCalculationResult || !applyFormulaCalculationResult) return;
+			requestIdleCallback(() => {
+				callback(result);
+			});
+		});
+	}
+	onCalculationResultApplied() {
+		return new Promise((resolve, reject) => {
+			let started = false;
+			let finished = false;
+			const mainTimer = setTimeout(() => {
+				cleanup();
+				reject(/* @__PURE__ */ new Error("Calculation end timeout"));
+			}, 6e4);
+			const startWatchdog = setTimeout(() => {
+				if (!started) {
+					cleanup();
+					resolve();
+				}
+			}, 500);
+			const processingDisposable = this.calculationProcessing((stageInfo) => {
+				const { stage, totalArrayFormulasToCalculate, totalFormulasToCalculate } = stageInfo;
+				if (stage === _univerjs_engine_formula.FormulaExecuteStageType.START_CALCULATION && totalArrayFormulasToCalculate + totalFormulasToCalculate === 0) {
+					cleanup();
+					resolve();
+					return;
+				}
+				if (started) return;
+				started = true;
+				clearTimeout(startWatchdog);
+			});
+			const endDisposable = this.calculationResultApplied(() => {
+				if (finished) return;
+				finished = true;
+				cleanup();
+				resolve();
+			});
+			function cleanup() {
+				clearTimeout(mainTimer);
+				clearTimeout(startWatchdog);
+				processingDisposable.dispose();
+				endDisposable.dispose();
+			}
+		});
+	}
+};
+_univerjs_engine_formula_facade.FFormula.extend(FFormulaSheetsMixin);
+
+//#endregion
+//#region src/facade/f-enum.ts
+/**
+* Copyright 2023-present DreamNum Co., Ltd.
+*
+* 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.
+*/
+var FSheetsFormulaEnumMixin = class extends _univerjs_core_facade.FEnum {
+	get CalculationMode() {
+		return _univerjs_sheets_formula.CalculationMode;
+	}
+};
+_univerjs_core_facade.FEnum.extend(FSheetsFormulaEnumMixin);
+
+//#endregion
+//#region src/facade/f-workbook.ts
+var FWorkbookEngineFormulaMixin = class extends _univerjs_sheets_facade.FWorkbook {
+	getAllFormulaError() {
+		const errors = [];
+		const workbook = this._workbook;
+		const unitId = workbook.getUnitId();
+		const worksheets = workbook.getSheets();
+		const arrayFormula = this._injector.get(_univerjs_engine_formula.FormulaDataModel).getArrayFormulaCellData();
+		worksheets.forEach((worksheet) => {
+			var _arrayFormula$unitId;
+			const sheetName = worksheet.getName();
+			const sheetId = worksheet.getSheetId();
+			const cellMatrix = worksheet.getCellMatrix();
+			const arrayFormulaSheet = (arrayFormula === null || arrayFormula === void 0 || (_arrayFormula$unitId = arrayFormula[unitId]) === null || _arrayFormula$unitId === void 0 ? void 0 : _arrayFormula$unitId[sheetId]) || {};
+			cellMatrix.forValue((row, column, cell) => {
+				var _arrayFormulaSheet$ro;
+				if (!cell) return;
+				const errorType = (0, _univerjs_engine_formula.extractFormulaError)(cell, !!(arrayFormulaSheet === null || arrayFormulaSheet === void 0 || (_arrayFormulaSheet$ro = arrayFormulaSheet[row]) === null || _arrayFormulaSheet$ro === void 0 ? void 0 : _arrayFormulaSheet$ro[column]));
+				if (errorType) errors.push({
+					sheetName,
+					row,
+					column,
+					formula: cell.f || "",
+					errorType
+				});
+			});
+		});
+		return errors;
+	}
+};
+_univerjs_sheets_facade.FWorkbook.extend(FWorkbookEngineFormulaMixin);
+
+//#endregion
+//#region src/facade/f-range.ts
+/**
+* @ignore
+*/
+var FRangeEngineFormulaMixin = class extends _univerjs_sheets_facade.FRange {
+	getFormulaError() {
+		var _arrayFormula$unitId;
+		const errors = [];
+		const unitId = this._workbook.getUnitId();
+		const sheetId = this._worksheet.getSheetId();
+		const sheetName = this._worksheet.getName();
+		const worksheet = this._workbook.getSheetBySheetId(sheetId);
+		if (!worksheet) return errors;
+		const arrayFormula = this._injector.get(_univerjs_engine_formula.FormulaDataModel).getArrayFormulaCellData();
+		const arrayFormulaSheet = (arrayFormula === null || arrayFormula === void 0 || (_arrayFormula$unitId = arrayFormula[unitId]) === null || _arrayFormula$unitId === void 0 ? void 0 : _arrayFormula$unitId[sheetId]) || {};
+		const cellMatrix = worksheet.getCellMatrix();
+		const { startRow, endRow, startColumn, endColumn } = this._range;
+		for (let row = startRow; row <= endRow; row++) for (let column = startColumn; column <= endColumn; column++) {
+			var _arrayFormulaSheet$ro;
+			const cell = cellMatrix.getValue(row, column);
+			if (!cell) continue;
+			const errorType = (0, _univerjs_engine_formula.extractFormulaError)(cell, !!(arrayFormulaSheet === null || arrayFormulaSheet === void 0 || (_arrayFormulaSheet$ro = arrayFormulaSheet[row]) === null || _arrayFormulaSheet$ro === void 0 ? void 0 : _arrayFormulaSheet$ro[column]));
+			if (errorType) errors.push({
+				sheetName,
+				row,
+				column,
+				formula: cell.f || "",
+				errorType
+			});
+		}
+		return errors;
+	}
+};
+_univerjs_sheets_facade.FRange.extend(FRangeEngineFormulaMixin);
+
+//#endregion