@univerjs/sheets-formula 0.21.0 → 0.21.1

package/lib/cjs/index.js

@@ -2055,7 +2055,7 @@ let UpdateFormulaController = class UpdateFormulaController extends _univerjs_co
 				this._handleSetRangeValuesMutation(params);
 			}
 		}));
-		this.disposeWithMe(this._univerInstanceService.getTypeOfUnitAdded$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).subscribe((unit) => this._handleWorkbookAdded(unit)));
+		this.disposeWithMe(this._univerInstanceService.getTypeOfUnitAdded$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).subscribe((event) => this._handleWorkbookAdded(event.unit)));
 		this.disposeWithMe(this._univerInstanceService.getTypeOfUnitDisposed$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).pipe((0, rxjs.map)((unit) => unit.getUnitId())).subscribe((unitId) => this._handleWorkbookDisposed(unitId)));
 	}
 	_handleSetRangeValuesMutation(params) {
@@ -2322,7 +2322,7 @@ UpdateFormulaController = __decorate([
 //#endregion
 //#region package.json
 var name = "@univerjs/sheets-formula";
-var version = "0.21.0";
+var version = "0.21.1";
 
 //#endregion
 //#region src/common/plugin-name.ts
@@ -15422,33 +15422,100 @@ function getFunctionName(item, localeService) {
 //#endregion
 //#region src/services/description.service.ts
 const IDescriptionService = (0, _univerjs_core.createIdentifier)("formula.description-service");
-let DescriptionService = class DescriptionService {
+let DescriptionService = class DescriptionService extends _univerjs_core.Disposable {
 	constructor(_functionService, _localeService, _configService) {
+		super();
 		this._functionService = _functionService;
 		this._localeService = _localeService;
 		this._configService = _configService;
-		_defineProperty(this, "_descriptions", []);
+		_defineProperty(this, "_descriptions", /* @__PURE__ */ new Map());
 		this._initialize();
 	}
+	_initialize() {
+		this.disposeWithMe((0, _univerjs_core.toDisposable)(this._localeService.localeChanged$.subscribe(() => {
+			this._functionService.clearDescriptions();
+			const newDescriptions = /* @__PURE__ */ new Map();
+			this._descriptions.forEach((item) => {
+				const functionName = getFunctionName(item, this._localeService).toUpperCase();
+				newDescriptions.set(functionName, item);
+			});
+			this._descriptions = newDescriptions;
+			this._initRegisterDescriptions();
+		})));
+		this._initDescriptions();
+		this._initRegisterDescriptions();
+	}
+	_initDescriptions() {
+		var _config$description;
+		const localeService = this._localeService;
+		FUNCTION_LIST.forEach((item) => {
+			if (_univerjs_engine_formula.ALL_IMPLEMENTED_FUNCTIONS_SET.has(item.functionName)) {
+				const functionName = getFunctionName(item, localeService).toUpperCase();
+				this._descriptions.set(functionName, item);
+			}
+		});
+		const config = this._configService.getConfig(PLUGIN_CONFIG_KEY_BASE);
+		config === null || config === void 0 || (_config$description = config.description) === null || _config$description === void 0 || _config$description.forEach((item) => {
+			const functionName = getFunctionName(item, localeService).toUpperCase();
+			this._descriptions.set(functionName, item);
+		});
+	}
+	_initRegisterDescriptions() {
+		const localeService = this._localeService;
+		const functionListLocale = Array.from(this._descriptions.values()).map((functionInfo) => ({
+			functionName: getFunctionName(functionInfo, localeService),
+			functionType: functionInfo.functionType,
+			description: localeService.t(functionInfo.description),
+			abstract: localeService.t(functionInfo.abstract),
+			functionParameter: functionInfo.functionParameter.map((item) => ({
+				name: localeService.t(item.name),
+				detail: localeService.t(item.detail),
+				example: item.example,
+				require: item.require,
+				repeat: item.repeat
+			}))
+		}));
+		this._functionService.registerDescriptions(...functionListLocale);
+	}
+	_registerDescriptions(descriptions) {
+		const localeService = this._localeService;
+		const functionListLocale = descriptions.map((functionInfo) => ({
+			functionName: getFunctionName(functionInfo, localeService),
+			functionType: functionInfo.functionType,
+			description: localeService.t(functionInfo.description),
+			abstract: localeService.t(functionInfo.abstract),
+			functionParameter: functionInfo.functionParameter.map((item) => ({
+				name: localeService.t(item.name),
+				detail: localeService.t(item.detail),
+				example: item.example,
+				require: item.require,
+				repeat: item.repeat
+			}))
+		}));
+		this._functionService.registerDescriptions(...functionListLocale);
+	}
 	dispose() {
-		this._localeService.localeChanged$.complete();
+		super.dispose();
+		this._descriptions.clear();
 	}
 	getDescriptions() {
 		return this._functionService.getDescriptions();
 	}
 	hasFunction(searchText) {
-		return this._functionService.getDescriptions().get(searchText.toLocaleUpperCase()) !== void 0;
+		return this._descriptions.has(searchText.toUpperCase());
 	}
 	getFunctionInfo(searchText) {
-		return this._functionService.getDescriptions().get(searchText.toLocaleUpperCase());
+		const item = this._descriptions.get(searchText.toUpperCase());
+		if (!item) return;
+		return this._functionService.getDescription(getFunctionName(item, this._localeService));
 	}
 	getSearchListByName(searchText) {
-		const searchList = [];
 		const functionList = this._functionService.getDescriptions();
-		const _searchText = searchText.toLocaleUpperCase().trim();
+		const _searchText = searchText.toUpperCase().trim();
+		const searchList = [];
 		functionList.forEach((item) => {
 			const { functionName, abstract, functionType } = item;
-			if (functionName.toLocaleUpperCase().indexOf(_searchText) > -1 && functionType !== _univerjs_engine_formula.FunctionType.DefinedName) searchList.push({
+			if (functionName.toUpperCase().indexOf(_searchText) > -1 && functionType !== _univerjs_engine_formula.FunctionType.DefinedName) searchList.push({
 				name: functionName,
 				desc: abstract
 			});
@@ -15456,12 +15523,12 @@ let DescriptionService = class DescriptionService {
 		return searchList;
 	}
 	getSearchListByNameFirstLetter(searchText) {
-		const searchList = [];
 		const functionList = this._functionService.getDescriptions();
-		const _searchText = searchText.toLocaleUpperCase().trim();
+		const _searchText = searchText.toUpperCase().trim();
+		const searchList = [];
 		functionList.forEach((item) => {
 			const { functionName, abstract, functionType } = item;
-			if (functionName.toLocaleUpperCase().indexOf(_searchText) === 0) searchList.push({
+			if (functionName.toUpperCase().indexOf(_searchText) === 0) searchList.push({
 				name: functionName,
 				desc: abstract,
 				functionType
@@ -15470,8 +15537,9 @@ let DescriptionService = class DescriptionService {
 		return searchList;
 	}
 	getSearchListByType(type) {
+		const functionList = this._functionService.getDescriptions();
 		const searchList = [];
-		this._functionService.getDescriptions().forEach((item) => {
+		functionList.forEach((item) => {
 			const { functionName, functionType, abstract } = item;
 			if ((functionType === type || type === -1) && functionType !== _univerjs_engine_formula.FunctionType.DefinedName) searchList.push({
 				name: functionName,
@@ -15480,79 +15548,43 @@ let DescriptionService = class DescriptionService {
 		});
 		return searchList;
 	}
-	registerDescriptions(description) {
-		this._descriptions = this._descriptions.concat(description);
-		this._registerDescriptions();
+	registerDescriptions(descriptions) {
+		const localeService = this._localeService;
+		const functionNames = [];
+		descriptions.forEach((item) => {
+			const functionName = getFunctionName(item, localeService).toUpperCase();
+			functionNames.push(functionName);
+			this._descriptions.set(functionName, item);
+		});
+		this._registerDescriptions(descriptions);
 		return (0, _univerjs_core.toDisposable)(() => {
-			const functionNames = description.map((item) => item.functionName);
 			this.unregisterDescriptions(functionNames);
 		});
 	}
 	unregisterDescriptions(functionNames) {
-		this._descriptions = this._descriptions.filter((item) => !functionNames.includes(item.functionName));
-		this._functionService.unregisterDescriptions(...functionNames);
+		const removeFunctionNames = [];
+		functionNames.forEach((name) => {
+			const functionName = name.toUpperCase();
+			const item = this._descriptions.get(functionName);
+			if (!item) return;
+			removeFunctionNames.push(getFunctionName(item, this._localeService));
+			this._descriptions.delete(functionName);
+		});
+		this._functionService.unregisterDescriptions(...removeFunctionNames);
 	}
 	hasDescription(name) {
-		return this._descriptions.some((item) => item.functionName === name);
+		return this._descriptions.has(name.toUpperCase());
 	}
 	hasDefinedNameDescription(name) {
-		return this._descriptions.some((item) => item.functionName === name && item.functionType === _univerjs_engine_formula.FunctionType.DefinedName);
+		const item = this._descriptions.get(name.toUpperCase());
+		if (!item) return false;
+		return item.functionType === _univerjs_engine_formula.FunctionType.DefinedName;
 	}
 	isFormulaDefinedName(name) {
-		const items = this._descriptions.filter((item) => item.functionName === name && item.functionType === _univerjs_engine_formula.FunctionType.DefinedName);
-		if (items.length === 0) return false;
-		const token = items[0].description;
-		return !(0, _univerjs_engine_formula.isReferenceStrings)(token);
-	}
-	_initialize() {
-		this._localeService.localeChanged$.subscribe(() => {
-			this._registerDescriptions();
-		});
-		this._initDescription();
-		this._registerDescriptions();
-	}
-	_initDescription() {
-		var _config$description;
-		const functions = [
-			..._univerjs_engine_formula.functionArray,
-			..._univerjs_engine_formula.functionCompatibility,
-			..._univerjs_engine_formula.functionCube,
-			..._univerjs_engine_formula.functionDatabase,
-			..._univerjs_engine_formula.functionDate,
-			..._univerjs_engine_formula.functionEngineering,
-			..._univerjs_engine_formula.functionFinancial,
-			..._univerjs_engine_formula.functionInformation,
-			..._univerjs_engine_formula.functionLogical,
-			..._univerjs_engine_formula.functionLookup,
-			..._univerjs_engine_formula.functionMath,
-			..._univerjs_engine_formula.functionMeta,
-			..._univerjs_engine_formula.functionStatistical,
-			..._univerjs_engine_formula.functionText,
-			..._univerjs_engine_formula.functionUniver,
-			..._univerjs_engine_formula.functionWeb
-		].map((item) => item[1]);
-		const filterFunctionList = FUNCTION_LIST.filter((item) => {
-			return functions.includes(item.functionName);
-		});
-		const config = this._configService.getConfig(PLUGIN_CONFIG_KEY_BASE);
-		this._descriptions = filterFunctionList.concat((_config$description = config === null || config === void 0 ? void 0 : config.description) !== null && _config$description !== void 0 ? _config$description : []);
-	}
-	_registerDescriptions() {
-		const localeService = this._localeService;
-		const functionListLocale = this._descriptions.map((functionInfo) => ({
-			functionName: getFunctionName(functionInfo, localeService),
-			functionType: functionInfo.functionType,
-			description: localeService.t(functionInfo.description),
-			abstract: localeService.t(functionInfo.abstract),
-			functionParameter: functionInfo.functionParameter.map((item) => ({
-				name: localeService.t(item.name),
-				detail: localeService.t(item.detail),
-				example: item.example,
-				require: item.require,
-				repeat: item.repeat
-			}))
-		}));
-		this._functionService.registerDescriptions(...functionListLocale);
+		const item = this._descriptions.get(name.toUpperCase());
+		if (!item) return false;
+		if (item.functionType !== _univerjs_engine_formula.FunctionType.DefinedName) return false;
+		return !(0, _univerjs_engine_formula.isReferenceStrings)(item.description);
 	}
 };
 DescriptionService = __decorate([
@@ -15579,37 +15611,66 @@ let DefinedNameController = class DefinedNameController extends _univerjs_core.D
 		this._changeSheetListener();
 	}
 	_descriptionListener() {
-		(0, _univerjs_core.toDisposable)(this._definedNamesService.update$.subscribe(() => {
-			this._registerDescriptions();
-		}));
+		this.disposeWithMe((0, _univerjs_core.toDisposable)(this._definedNamesService.update$.subscribe((event) => {
+			this._updateDescriptions(event);
+		})));
 	}
 	_changeUnitListener() {
-		(0, _univerjs_core.toDisposable)(this._univerInstanceService.getCurrentTypeOfUnit$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).subscribe((workbook) => {
+		this.disposeWithMe((0, _univerjs_core.toDisposable)(this._univerInstanceService.getCurrentTypeOfUnit$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).subscribe((workbook) => {
 			this._unRegisterDescriptions();
-			if (workbook) this._registerDescriptions();
-		}));
+			if (workbook) this._initRegisterDescriptions(workbook.getUnitId());
+		})));
 	}
 	_changeSheetListener() {
 		this.disposeWithMe(this._commandService.onCommandExecuted((command, options) => {
 			if (options === null || options === void 0 ? void 0 : options.fromCollab) return;
 			if (command.id === _univerjs_sheets.SetWorksheetActiveOperation.id) {
-				this._unregisterDescriptionsForNotInSheetId();
-				this._registerDescriptions();
+				const params = command.params;
+				this._unregisterDescriptionsForNotInSheetId(params.unitId, params.subUnitId);
+				this._initRegisterDescriptions(params.unitId, params.subUnitId);
 			} else if (command.id === _univerjs_engine_formula.SetDefinedNameMutation.id) {
-				const param = command.params;
-				this._registerDescription(param);
+				const params = command.params;
+				this._registerDescription(params);
 			} else if (command.id === _univerjs_engine_formula.RemoveDefinedNameMutation.id) {
-				const param = command.params;
-				this._unregisterDescription(param);
+				const params = command.params;
+				this._unregisterDescription(params);
 			}
 		}));
 	}
-	_registerDescription(param) {
-		const target = this._getUnitIdAndSheetId(param);
+	_updateDescriptions(event) {
+		const target = (0, _univerjs_sheets.getSheetCommandTarget)(this._univerInstanceService);
 		if (!target) return;
-		const { sheetId } = target;
-		const { name, comment, formulaOrRefString, localSheetId } = param;
-		if (!this._descriptionService.hasDescription(name) && (localSheetId == null || localSheetId === _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME || localSheetId === sheetId)) this._descriptionService.registerDescriptions([{
+		const { unitId, subUnitId } = target;
+		const { type, unitId: updateUnitId, definedNames } = event;
+		if (updateUnitId !== unitId) return;
+		if (type === "update") {
+			const functionList = [];
+			definedNames.forEach((definedName) => {
+				const { name, comment, formulaOrRefString, localSheetId } = definedName;
+				if (localSheetId == null || localSheetId === _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME || localSheetId === subUnitId) functionList.push({
+					functionName: name,
+					description: formulaOrRefString + (comment || ""),
+					abstract: formulaOrRefString,
+					functionType: _univerjs_engine_formula.FunctionType.DefinedName,
+					functionParameter: []
+				});
+			});
+			this._descriptionService.registerDescriptions(functionList);
+		} else if (type === "remove") {
+			const functionList = [];
+			definedNames.forEach((definedName) => {
+				functionList.push(definedName.name);
+			});
+			this._descriptionService.unregisterDescriptions(functionList);
+		}
+	}
+	_registerDescription(params) {
+		const target = (0, _univerjs_sheets.getSheetCommandTarget)(this._univerInstanceService, params);
+		if (!target) return;
+		const { subUnitId } = target;
+		const { name, comment, formulaOrRefString, localSheetId } = params;
+		if (this._descriptionService.hasDescription(name)) return;
+		if (localSheetId == null || localSheetId === _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME || localSheetId === subUnitId) this._descriptionService.registerDescriptions([{
 			functionName: name,
 			description: formulaOrRefString + (comment || ""),
 			abstract: formulaOrRefString,
@@ -15622,9 +15683,9 @@ let DefinedNameController = class DefinedNameController extends _univerjs_core.D
 		this._descriptionService.unregisterDescriptions([name]);
 	}
 	_unRegisterDescriptions() {
-		if (this._preUnitId == null) return;
+		if (this._preUnitId === null) return;
 		const definedNames = this._definedNamesService.getDefinedNameMap(this._preUnitId);
-		if (definedNames == null) return;
+		if (!definedNames) return;
 		const functionList = [];
 		Array.from(Object.values(definedNames)).forEach((value) => {
 			const { name } = value;
@@ -15633,28 +15694,21 @@ let DefinedNameController = class DefinedNameController extends _univerjs_core.D
 		this._descriptionService.unregisterDescriptions(functionList);
 		this._preUnitId = null;
 	}
-	_getUnitIdAndSheetId(params = {}) {
-		const { unitId, subUnitId } = params;
-		const workbook = unitId ? this._univerInstanceService.getUnit(unitId, _univerjs_core.UniverInstanceType.UNIVER_SHEET) : this._univerInstanceService.getCurrentUnitOfType(_univerjs_core.UniverInstanceType.UNIVER_SHEET);
-		if (!workbook) return null;
-		const worksheet = subUnitId ? workbook.getSheetBySheetId(subUnitId) : workbook.getActiveSheet(true);
-		if (!worksheet) return null;
-		return {
-			unitId: workbook.getUnitId(),
-			sheetId: worksheet.getSheetId()
-		};
-	}
-	_registerDescriptions() {
-		const target = this._getUnitIdAndSheetId();
+	_initRegisterDescriptions(unitId, subUnitId) {
+		const target = (0, _univerjs_sheets.getSheetCommandTarget)(this._univerInstanceService, {
+			unitId,
+			subUnitId
+		});
 		if (!target) return;
-		const { unitId, sheetId } = target;
-		const definedNames = this._definedNamesService.getDefinedNameMap(unitId);
+		const { unitId: _unitId, subUnitId: _subUnitId } = target;
+		const definedNames = this._definedNamesService.getDefinedNameMap(_unitId);
 		if (!definedNames) return;
 		const functionList = [];
-		this._preUnitId = unitId;
+		this._preUnitId = _unitId;
 		Array.from(Object.values(definedNames)).forEach((value) => {
 			const { name, comment, formulaOrRefString, localSheetId } = value;
-			if (!this._descriptionService.hasDescription(name) && (localSheetId == null || localSheetId === _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME || localSheetId === sheetId)) functionList.push({
+			if (this._descriptionService.hasDescription(name)) return;
+			if (localSheetId == null || localSheetId === _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME || localSheetId === _subUnitId) functionList.push({
 				functionName: name,
 				description: formulaOrRefString + (comment || ""),
 				abstract: formulaOrRefString,
@@ -15664,16 +15718,13 @@ let DefinedNameController = class DefinedNameController extends _univerjs_core.D
 		});
 		this._descriptionService.registerDescriptions(functionList);
 	}
-	_unregisterDescriptionsForNotInSheetId() {
-		const target = this._getUnitIdAndSheetId();
-		if (!target) return;
-		const { unitId, sheetId } = target;
+	_unregisterDescriptionsForNotInSheetId(unitId, subUnitId) {
 		const definedNames = this._definedNamesService.getDefinedNameMap(unitId);
 		if (!definedNames) return;
 		const functionList = [];
 		Array.from(Object.values(definedNames)).forEach((value) => {
 			const { name, localSheetId } = value;
-			if (localSheetId !== _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME && localSheetId !== sheetId) functionList.push(name);
+			if (localSheetId !== _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME && localSheetId !== subUnitId) functionList.push(name);
 		});
 		this._descriptionService.unregisterDescriptions(functionList);
 	}
@@ -16180,19 +16231,16 @@ let RegisterFunctionService = class RegisterFunctionService extends _univerjs_co
 		const { locales, description, calculate } = params;
 		if (locales) this._localeService.load(locales);
 		const disposables = new _univerjs_core.DisposableCollection();
-		if (description) disposables.add(this._descriptionService.registerDescriptions(description));
-		else {
-			const descriptionList = calculate.map(([_func, functionName, functionIntroduction]) => {
-				return {
-					functionName,
-					functionType: _univerjs_engine_formula.FunctionType.User,
-					description: "",
-					abstract: functionIntroduction || "",
-					functionParameter: []
-				};
-			});
-			disposables.add(this._functionService.registerDescriptions(...descriptionList));
-		}
+		const descriptions = description !== null && description !== void 0 ? description : calculate.map(([_func, functionName, functionIntroduction]) => {
+			return {
+				functionName,
+				functionType: _univerjs_engine_formula.FunctionType.User,
+				description: "",
+				abstract: functionIntroduction || "",
+				functionParameter: []
+			};
+		});
+		disposables.add(this._descriptionService.registerDescriptions(descriptions));
 		disposables.add(this._registerLocalExecutors(calculate));
 		if (this._remoteRegisterFunctionService) disposables.add(this._registerRemoteExecutors(calculate));
 		return disposables;