@univerjs/sheets-formula 0.20.1 → 0.21.0

package/lib/cjs/locale/ca-ES.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`Analitzant`,calculating:`Calculant`,"array-analysis":`Anàlisi de matriu`,"array-calculation":`Càlcul de matriu`,done:`Fet`}}};module.exports=e;
+
+//#region src/locale/ca-ES.ts
+const locale = { formula: { progress: {
+	analyzing: "Analitzant",
+	calculating: "Calculant",
+	"array-analysis": "Anàlisi de matriu",
+	"array-calculation": "Càlcul de matriu",
+	done: "Fet"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/en-US.js

@@ -1 +1,27 @@
-const e={formula:{progress:{analyzing:`Analyzing`,calculating:`Calculating`,"array-analysis":`Array Analysis`,"array-calculation":`Array Calculation`,done:`Done`}}};module.exports=e;
+
+//#region src/locale/en-US.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.
+*/
+const locale = { formula: { progress: {
+	analyzing: "Analyzing",
+	calculating: "Calculating",
+	"array-analysis": "Array Analysis",
+	"array-calculation": "Array Calculation",
+	done: "Done"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/es-ES.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`Analizando`,calculating:`Calculando`,"array-analysis":`Análisis de matriz`,"array-calculation":`Cálculo de matriz`,done:`Hecho`}}};module.exports=e;
+
+//#region src/locale/es-ES.ts
+const locale = { formula: { progress: {
+	analyzing: "Analizando",
+	calculating: "Calculando",
+	"array-analysis": "Análisis de matriz",
+	"array-calculation": "Cálculo de matriz",
+	done: "Hecho"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/fa-IR.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`در حال تحلیل`,calculating:`در حال محاسبه`,"array-analysis":`تحلیل آرایه`,"array-calculation":`محاسبه آرایه`,done:`تمام`}}};module.exports=e;
+
+//#region src/locale/fa-IR.ts
+const locale = { formula: { progress: {
+	analyzing: "در حال تحلیل",
+	calculating: "در حال محاسبه",
+	"array-analysis": "تحلیل آرایه",
+	"array-calculation": "محاسبه آرایه",
+	done: "تمام"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/fr-FR.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`Analyse en cours`,calculating:`Calcul en cours`,"array-analysis":`Analyse de tableau`,"array-calculation":`Calcul de tableau`,done:`Terminé`}}};module.exports=e;
+
+//#region src/locale/fr-FR.ts
+const locale = { formula: { progress: {
+	analyzing: "Analyse en cours",
+	calculating: "Calcul en cours",
+	"array-analysis": "Analyse de tableau",
+	"array-calculation": "Calcul de tableau",
+	done: "Terminé"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/ja-JP.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`解析中`,calculating:`計算中`,"array-analysis":`配列の解析`,"array-calculation":`配列の計算`,done:`完了`}}};module.exports=e;
+
+//#region src/locale/ja-JP.ts
+const locale = { formula: { progress: {
+	analyzing: "解析中",
+	calculating: "計算中",
+	"array-analysis": "配列の解析",
+	"array-calculation": "配列の計算",
+	done: "完了"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/ko-KR.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`분석 중`,calculating:`계산 중`,"array-analysis":`배열 분석`,"array-calculation":`배열 계산`,done:`완료`}}};module.exports=e;
+
+//#region src/locale/ko-KR.ts
+const locale = { formula: { progress: {
+	analyzing: "분석 중",
+	calculating: "계산 중",
+	"array-analysis": "배열 분석",
+	"array-calculation": "배열 계산",
+	done: "완료"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/ru-RU.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`Анализ`,calculating:`Вычисление`,"array-analysis":`Анализ массива`,"array-calculation":`Вычисление массива`,done:`Готово`}}};module.exports=e;
+
+//#region src/locale/ru-RU.ts
+const locale = { formula: { progress: {
+	analyzing: "Анализ",
+	calculating: "Вычисление",
+	"array-analysis": "Анализ массива",
+	"array-calculation": "Вычисление массива",
+	done: "Готово"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/sk-SK.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`Analyzovanie`,calculating:`Výpočet`,"array-analysis":`Analýza poľa`,"array-calculation":`Výpočet poľa`,done:`Hotovo`}}};module.exports=e;
+
+//#region src/locale/sk-SK.ts
+const locale = { formula: { progress: {
+	analyzing: "Analyzovanie",
+	calculating: "Výpočet",
+	"array-analysis": "Analýza poľa",
+	"array-calculation": "Výpočet poľa",
+	done: "Hotovo"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/vi-VN.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`Đang phân tích`,calculating:`Đang tính toán`,"array-analysis":`Phân tích mảng`,"array-calculation":`Tính toán mảng`,done:`Hoàn tất`}}};module.exports=e;
+
+//#region src/locale/vi-VN.ts
+const locale = { formula: { progress: {
+	analyzing: "Đang phân tích",
+	calculating: "Đang tính toán",
+	"array-analysis": "Phân tích mảng",
+	"array-calculation": "Tính toán mảng",
+	done: "Hoàn tất"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/zh-CN.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`分析中`,calculating:`计算中`,"array-analysis":`数组分析`,"array-calculation":`数组计算`,done:`完成`}}};module.exports=e;
+
+//#region src/locale/zh-CN.ts
+const locale = { formula: { progress: {
+	analyzing: "分析中",
+	calculating: "计算中",
+	"array-analysis": "数组分析",
+	"array-calculation": "数组计算",
+	done: "完成"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/cjs/locale/zh-TW.js

@@ -1 +1,12 @@
-const e={formula:{progress:{analyzing:`分析中`,calculating:`計算中`,"array-analysis":`陣列分析`,"array-calculation":`陣列計算`,done:`完成`}}};module.exports=e;
+
+//#region src/locale/zh-TW.ts
+const locale = { formula: { progress: {
+	analyzing: "分析中",
+	calculating: "計算中",
+	"array-analysis": "陣列分析",
+	"array-calculation": "陣列計算",
+	done: "完成"
+} } };
+
+//#endregion
+module.exports = locale;

package/lib/es/facade.js

@@ -1 +1,253 @@
-import{IConfigService as e,ILogService as t,LifecycleService as n,LifecycleStages as r,debounce as i}from"@univerjs/core";import{FEnum as a,FUniver as o}from"@univerjs/core/facade";import{FormulaDataModel as s,FormulaExecuteStageType as c,SetFormulaCalculationResultMutation as l,SetTriggerFormulaCalculationStartMutation as u,extractFormulaError as d}from"@univerjs/engine-formula";import{CalculationMode as f,IRegisterFunctionService as p,PLUGIN_CONFIG_KEY_BASE as m,RegisterFunctionService as h}from"@univerjs/sheets-formula";import{FFormula as g}from"@univerjs/engine-formula/facade";import{SetRangeValuesMutation as _}from"@univerjs/sheets";import{FRange as v,FWorkbook as y}from"@univerjs/sheets/facade";var b=class extends o{_initialize(){this._debouncedFormulaCalculation=i(()=>{this._commandService.executeCommand(u.id,{commands:[],forceCalculation:!0},{onlyLocal:!0})},10)}registerFunction(e){let t=this._injector.get(p);t||(this._injector.add([p,{useClass:h}]),t=this._injector.get(p));let n=t.registerFunctions(e);return this._debouncedFormulaCalculation(),n}};o.extend(b);var x=class extends g{_initialize(){this._debouncedFormulaCalculation=i(()=>{this._commandService.executeCommand(u.id,{commands:[],forceCalculation:!0},{onlyLocal:!0})},10)}setInitialFormulaComputing(i){let a=this._injector.get(n).stage,o=this._injector.get(t),s=this._injector.get(e);a>r.Starting&&o.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 c=s.getConfig(m);if(!c){s.setConfig(m,{initialFormulaComputing:i});return}c.initialFormulaComputing=i}registerFunction(e,t,n){var r;let i=this._injector.get(p);i||(this._injector.add([p,{useClass:h}]),i=this._injector.get(p));let a={name:e,func:t,description:typeof n==`string`?n:(r=n==null?void 0:n.description)==null?``:r,locales:typeof n==`object`?n.locales:void 0},o=i.registerFunction(a);return this._debouncedFormulaCalculation(),o}registerAsyncFunction(e,t,n){var r;let i=this._injector.get(p);i||(this._injector.add([p,{useClass:h}]),i=this._injector.get(p));let a={name:e,func:t,description:typeof n==`string`?n:(r=n==null?void 0:n.description)==null?``:r,locales:typeof n==`object`?n.locales:void 0},o=i.registerAsyncFunction(a);return this._debouncedFormulaCalculation(),o}calculationResultApplied(e){let t=!1,n=!1,r=null;return this._commandService.onCommandExecuted((i,a)=>{i.id!==l.id&&i.id!==_.id||(i.id===l.id&&(t=!0,r=i.params),i.id===_.id&&a!=null&&a.applyFormulaCalculationResult&&(n=!0),!(!t||!n)&&requestIdleCallback(()=>{e(r)}))})}onCalculationResultApplied(){return new Promise((e,t)=>{let n=!1,r=!1,i=setTimeout(()=>{l(),t(Error(`Calculation end timeout`))},6e4),a=setTimeout(()=>{n||(l(),e())},500),o=this.calculationProcessing(t=>{let{stage:r,totalArrayFormulasToCalculate:i,totalFormulasToCalculate:o}=t;if(r===c.START_CALCULATION&&i+o===0){l(),e();return}n||(n=!0,clearTimeout(a))}),s=this.calculationResultApplied(()=>{r||(r=!0,l(),e())});function l(){clearTimeout(i),clearTimeout(a),o.dispose(),s.dispose()}})}};g.extend(x);var S=class extends a{get CalculationMode(){return f}};a.extend(S);var C=class extends y{getAllFormulaError(){let e=[],t=this._workbook,n=t.getUnitId(),r=t.getSheets(),i=this._injector.get(s).getArrayFormulaCellData();return r.forEach(t=>{var r;let a=t.getName(),o=t.getSheetId(),s=t.getCellMatrix(),c=(i==null||(r=i[n])==null?void 0:r[o])||{};s.forValue((t,n,r)=>{var i;if(!r)return;let o=d(r,!!(!(c==null||(i=c[t])==null)&&i[n]));o&&e.push({sheetName:a,row:t,column:n,formula:r.f||``,errorType:o})})}),e}};y.extend(C);var w=class extends v{getFormulaError(){var e;let t=[],n=this._workbook.getUnitId(),r=this._worksheet.getSheetId(),i=this._worksheet.getName(),a=this._workbook.getSheetBySheetId(r);if(!a)return t;let o=this._injector.get(s).getArrayFormulaCellData(),c=(o==null||(e=o[n])==null?void 0:e[r])||{},l=a.getCellMatrix(),{startRow:u,endRow:f,startColumn:p,endColumn:m}=this._range;for(let e=u;e<=f;e++)for(let n=p;n<=m;n++){var h;let r=l.getValue(e,n);if(!r)continue;let a=d(r,!!(!(c==null||(h=c[e])==null)&&h[n]));a&&t.push({sheetName:i,row:e,column:n,formula:r.f||``,errorType:a})}return t}};v.extend(w);export{};
+import { IConfigService, ILogService, LifecycleService, LifecycleStages, debounce } from "@univerjs/core";
+import { FEnum, FUniver } from "@univerjs/core/facade";
+import { FormulaDataModel, FormulaExecuteStageType, SetFormulaCalculationResultMutation, SetTriggerFormulaCalculationStartMutation, extractFormulaError } from "@univerjs/engine-formula";
+import { CalculationMode, IRegisterFunctionService, PLUGIN_CONFIG_KEY_BASE, RegisterFunctionService } from "@univerjs/sheets-formula";
+import { FFormula } from "@univerjs/engine-formula/facade";
+import { SetRangeValuesMutation } from "@univerjs/sheets";
+import { FRange, FWorkbook } from "@univerjs/sheets/facade";
+
+//#region src/facade/f-univer.ts
+/**
+* @ignore
+*/
+var FUniverSheetsFormulaMixin = class extends FUniver {
+	/**
+	* Initialize the FUniver instance.
+	* @ignore
+	*/
+	_initialize() {
+		this._debouncedFormulaCalculation = debounce(() => {
+			this._commandService.executeCommand(SetTriggerFormulaCalculationStartMutation.id, {
+				commands: [],
+				forceCalculation: true
+			}, { onlyLocal: true });
+		}, 10);
+	}
+	registerFunction(config) {
+		let registerFunctionService = this._injector.get(IRegisterFunctionService);
+		if (!registerFunctionService) {
+			this._injector.add([IRegisterFunctionService, { useClass: RegisterFunctionService }]);
+			registerFunctionService = this._injector.get(IRegisterFunctionService);
+		}
+		const functionsDisposable = registerFunctionService.registerFunctions(config);
+		this._debouncedFormulaCalculation();
+		return functionsDisposable;
+	}
+};
+FUniver.extend(FUniverSheetsFormulaMixin);
+
+//#endregion
+//#region src/facade/f-formula.ts
+var FFormulaSheetsMixin = class extends FFormula {
+	/**
+	* Initialize the FUniver instance.
+	* @ignore
+	*/
+	_initialize() {
+		this._debouncedFormulaCalculation = debounce(() => {
+			this._commandService.executeCommand(SetTriggerFormulaCalculationStartMutation.id, {
+				commands: [],
+				forceCalculation: true
+			}, { onlyLocal: true });
+		}, 10);
+	}
+	setInitialFormulaComputing(calculationMode) {
+		const lifecycleStage = this._injector.get(LifecycleService).stage;
+		const logService = this._injector.get(ILogService);
+		const configService = this._injector.get(IConfigService);
+		if (lifecycleStage > 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(PLUGIN_CONFIG_KEY_BASE);
+		if (!config) {
+			configService.setConfig(PLUGIN_CONFIG_KEY_BASE, { initialFormulaComputing: calculationMode });
+			return;
+		}
+		config.initialFormulaComputing = calculationMode;
+	}
+	registerFunction(name, func, options) {
+		var _options$description;
+		let registerFunctionService = this._injector.get(IRegisterFunctionService);
+		if (!registerFunctionService) {
+			this._injector.add([IRegisterFunctionService, { useClass: RegisterFunctionService }]);
+			registerFunctionService = this._injector.get(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(IRegisterFunctionService);
+		if (!registerFunctionService) {
+			this._injector.add([IRegisterFunctionService, { useClass: RegisterFunctionService }]);
+			registerFunctionService = this._injector.get(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 !== SetFormulaCalculationResultMutation.id && command.id !== SetRangeValuesMutation.id) return;
+			if (command.id === SetFormulaCalculationResultMutation.id) {
+				setFormulaCalculationResult = true;
+				result = command.params;
+			}
+			if (command.id === 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 === 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();
+			}
+		});
+	}
+};
+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 FEnum {
+	get CalculationMode() {
+		return CalculationMode;
+	}
+};
+FEnum.extend(FSheetsFormulaEnumMixin);
+
+//#endregion
+//#region src/facade/f-workbook.ts
+var FWorkbookEngineFormulaMixin = class extends FWorkbook {
+	getAllFormulaError() {
+		const errors = [];
+		const workbook = this._workbook;
+		const unitId = workbook.getUnitId();
+		const worksheets = workbook.getSheets();
+		const arrayFormula = this._injector.get(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 = 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;
+	}
+};
+FWorkbook.extend(FWorkbookEngineFormulaMixin);
+
+//#endregion
+//#region src/facade/f-range.ts
+/**
+* @ignore
+*/
+var FRangeEngineFormulaMixin = class extends 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(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 = 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;
+	}
+};
+FRange.extend(FRangeEngineFormulaMixin);
+
+//#endregion
+export {  };