@univerjs/sheets 0.21.0 → 0.21.1

package/lib/cjs/facade.js

@@ -85,15 +85,14 @@ function getDefinedNameFieldName(unitId, localeService, definedNamesService) {
 		i++;
 	}
 }
-/**
-* @hideconstructor
-*/
-var FDefinedNameBuilder = class {
-	constructor() {
+let FDefinedNameBuilder = class FDefinedNameBuilder {
+	constructor(unitId, _injector) {
+		this.unitId = unitId;
+		this._injector = _injector;
 		_defineProperty(this, "_definedNameParam", void 0);
 		this._definedNameParam = {
 			id: (0, _univerjs_core.generateRandomId)(10),
-			unitId: "",
+			unitId,
 			name: "",
 			formulaOrRefString: "",
 			localSheetId: _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME
@@ -106,11 +105,11 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRef('Sheet1!$A$1')
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setName(name) {
@@ -124,11 +123,11 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setFormula('SUM(Sheet1!$A$1)')
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setFormula(formula) {
@@ -142,11 +141,11 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRef('Sheet1!$A$1')
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setRef(a1Notation) {
@@ -163,11 +162,11 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRefByRange(1, 3, 2, 5) // D2:H3
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setRefByRange(row, column, numRows, numColumns) {
@@ -186,12 +185,12 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRef('Sheet1!$A$1')
 	*   .setComment('A reference to A1 cell in Sheet1')
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setComment(comment) {
@@ -208,12 +207,12 @@ var FDefinedNameBuilder = class {
 	* const sheets = fWorkbook.getSheets();
 	*
 	* // Create a defined name and make it available only in the second worksheet
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRef('Sheet1!$A$1')
 	*   .setScopeToWorksheet(sheets[1])
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setScopeToWorksheet(worksheet) {
@@ -228,12 +227,12 @@ var FDefinedNameBuilder = class {
 	* const fWorkbook = univerAPI.getActiveWorkbook();
 	*
 	* // Create a defined name and make it available in the entire workbook
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRef('Sheet1!$A$1')
 	*   .setScopeToWorkbook()
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setScopeToWorkbook() {
@@ -247,12 +246,12 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRef('Sheet1!$A$1')
 	*   .setHidden(true)
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	setHidden(hidden) {
@@ -265,15 +264,26 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setName('MyDefinedName')
 	*   .setRef('Sheet1!$A$1')
 	*   .setComment('A reference to A1 cell in Sheet1')
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	build() {
+		const { unitId, name, formulaOrRefString, id } = this._definedNameParam;
+		const validationResult = (0, _univerjs_sheets.validateDefinedName)(name, {
+			unitId,
+			formulaOrRefString,
+			univerInstanceService: this._injector.get(_univerjs_core.IUniverInstanceService),
+			definedNamesService: this._injector.get(_univerjs_engine_formula.IDefinedNamesService),
+			superTableService: this._injector.get(_univerjs_engine_formula.ISuperTableService),
+			functionService: this._injector.get(_univerjs_engine_formula.IFunctionService),
+			id
+		});
+		if (typeof validationResult === "string") throw new TypeError(this._injector.get(_univerjs_core.LocaleService).t(validationResult));
 		return this._definedNameParam;
 	}
 	/**
@@ -283,23 +293,25 @@ var FDefinedNameBuilder = class {
 	* @example
 	* ```ts
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameParam = {
-	*   id: '4TMPceoqg8',
-	*   unitId: fWorkbook.getId(),
-	*   name: 'MyDefinedName',
-	*   formulaOrRefString: 'Sheet1!$A$1',
-	* }
-	* const definedNameBuilder = univerAPI.newDefinedName()
-	*   .load(definedNameParam)
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
+	*   .load({
+	*     id: '4TMPceoqg8',
+	*     name: 'MyDefinedName',
+	*     formulaOrRefString: 'Sheet1!$A$1',
+	*   })
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	load(param) {
-		this._definedNameParam = param;
+		this._definedNameParam = {
+			...this._definedNameParam,
+			...param
+		};
 		return this;
 	}
 };
+FDefinedNameBuilder = __decorate([__decorateParam(1, (0, _univerjs_core.Inject)(_univerjs_core.Injector))], FDefinedNameBuilder);
 let FDefinedName = class FDefinedName extends _univerjs_core_facade.FBase {
 	constructor(_definedNameParam, _injector, _commandService, _permissionService, _worksheetProtectionRuleModel, _rangeProtectionRuleModel, _worksheetProtectionPointRuleModel, _authzIoService, _localeService, _definedNamesService) {
 		super();
@@ -525,15 +537,16 @@ let FDefinedName = class FDefinedName extends _univerjs_core_facade.FBase {
 	* const fWorkbook = univerAPI.getActiveWorkbook();
 	* const definedName = fWorkbook.getDefinedNames()[0];
 	* if (!definedName) return;
-	* const definedNameBuilder = definedName
+	* const definedNameParam = definedName
 	*   .toBuilder()
 	*   .setName('NewDefinedName')
 	*   .setFormula('SUM(Sheet1!$A$1)')
 	*   .build();
-	* fWorkbook.updateDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.updateDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	toBuilder() {
+		if (!this._definedNameParam.unitId) throw new Error("unitId is required to convert to FDefinedNameBuilder");
 		const builder = this._injector.createInstance(FDefinedNameBuilder);
 		builder.load(this._definedNameParam);
 		return builder;
@@ -945,7 +958,7 @@ function determineScope(editState, viewState) {
 function handleWorksheetRangePermissionIsEmpty(injector, unitId, subUnitId) {
 	const rangeProtectionRuleModel = injector.get(_univerjs_sheets.RangeProtectionRuleModel);
 	const worksheetProtectionPointModel = injector.get(_univerjs_sheets.WorksheetProtectionPointModel);
-	const permissionService = injector.get(_univerjs_core.PermissionService);
+	const permissionService = injector.get(_univerjs_core.IPermissionService);
 	if (rangeProtectionRuleModel.getSubunitRuleList(unitId, subUnitId).length > 0) return;
 	worksheetProtectionPointModel.deleteRule(unitId, subUnitId);
 	[...(0, _univerjs_sheets.getAllWorksheetPermissionPointByPointPanel)()].forEach((F) => {
@@ -994,7 +1007,7 @@ async function getListRangeProtectionRules(injector, unitId, subUnitId, options)
 //#endregion
 //#region src/facade/permission/f-range-protection-rule.ts
 let FRangeProtectionRule = class FRangeProtectionRule {
-	constructor(_unitId, _subUnitId, _ruleId, _permissionId, _ranges, _options, _injector, _commandService, _permissionService, _authzIoService, _rangeProtectionRuleModel) {
+	constructor(_unitId, _subUnitId, _ruleId, _permissionId, _ranges, _options, _injector, _permissionService, _authzIoService, _commandService, _rangeProtectionRuleModel) {
 		this._unitId = _unitId;
 		this._subUnitId = _subUnitId;
 		this._ruleId = _ruleId;
@@ -1002,9 +1015,9 @@ let FRangeProtectionRule = class FRangeProtectionRule {
 		this._ranges = _ranges;
 		this._options = _options;
 		this._injector = _injector;
-		this._commandService = _commandService;
 		this._permissionService = _permissionService;
 		this._authzIoService = _authzIoService;
+		this._commandService = _commandService;
 		this._rangeProtectionRuleModel = _rangeProtectionRuleModel;
 	}
 	/**
@@ -1270,9 +1283,9 @@ let FRangeProtectionRule = class FRangeProtectionRule {
 };
 FRangeProtectionRule = __decorate([
 	__decorateParam(6, (0, _univerjs_core.Inject)(_univerjs_core.Injector)),
-	__decorateParam(7, (0, _univerjs_core.Inject)(_univerjs_core.ICommandService)),
-	__decorateParam(8, (0, _univerjs_core.Inject)(_univerjs_core.IPermissionService)),
-	__decorateParam(9, (0, _univerjs_core.Inject)(_univerjs_core.IAuthzIoService)),
+	__decorateParam(7, _univerjs_core.IPermissionService),
+	__decorateParam(8, _univerjs_core.IAuthzIoService),
+	__decorateParam(9, _univerjs_core.ICommandService),
 	__decorateParam(10, (0, _univerjs_core.Inject)(_univerjs_sheets.RangeProtectionRuleModel))
 ], FRangeProtectionRule);
 
@@ -3901,9 +3914,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
 	* ```
 	*/
 	insertDefinedName(name, formulaOrRefString) {
-		const param = this._injector.createInstance(FDefinedNameBuilder).setName(name).setRef(formulaOrRefString).build();
-		param.localSheetId = this.getSheetId();
-		this._fWorkbook.insertDefinedNameBuilder(param);
+		const definedNameParam = this._injector.createInstance(FDefinedNameBuilder, this._fWorkbook.getId()).setName(name).setRef(formulaOrRefString).setScopeToWorksheet(this).build();
+		this._fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	}
 	/**
 	* Get all the defined names in the worksheet.
@@ -7510,10 +7522,6 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
 	* const fWorkbook = univerAPI.getActiveWorkbook();
 	* const definedName = fWorkbook.getDefinedName('MyDefinedName');
 	* console.log(definedName?.getFormulaOrRefString());
-	*
-	* if (definedName) {
-	*   definedName.setName('NewDefinedName');
-	* }
 	* ```
 	*/
 	getDefinedName(name) {
@@ -7546,41 +7554,22 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
 		});
 	}
 	/**
-	* Insert a defined name.
-	* @param {string} name The name of the defined name to insert
-	* @param {string} formulaOrRefString The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert
-	* @returns {FWorkbook} The current FWorkbook instance
+	* Create a new defined name builder.
+	* @returns {FDefinedNameBuilder} - The defined name builder.
 	* @example
 	* ```ts
-	* // The code below inserts a defined name
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
+	*   .setRef('Sheet1!$A$1')
+	*   .setName('MyDefinedName')
+	*   .setComment('This is a comment');
+	*   .build();
+	* console.log(definedNameParam);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
-	insertDefinedName(name, formulaOrRefString) {
-		const param = this._injector.createInstance(FDefinedNameBuilder).setName(name).setRef(formulaOrRefString).build();
-		param.localSheetId = _univerjs_sheets.SCOPE_WORKBOOK_VALUE_DEFINED_NAME;
-		this.insertDefinedNameBuilder(param);
-		return this;
-	}
-	/**
-	* Delete the defined name with the given name.
-	* @param {string} name The name of the defined name to delete
-	* @returns {boolean} true if the defined name was deleted, false otherwise
-	* @example
-	* ```ts
-	* // The code below deletes the defined name with the given name
-	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* fWorkbook.deleteDefinedName('MyDefinedName');
-	* ```
-	*/
-	deleteDefinedName(name) {
-		const definedName = this.getDefinedName(name);
-		if (definedName) {
-			definedName.delete();
-			return true;
-		}
-		return false;
+	newDefinedNameBuilder() {
+		return this._injector.createInstance(FDefinedNameBuilder, this.id);
 	}
 	/**
 	* Insert a defined name by builder param.
@@ -7590,16 +7579,15 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
 	* ```ts
 	* // The code below inserts a defined name by builder param
 	* const fWorkbook = univerAPI.getActiveWorkbook();
-	* const definedNameBuilder = univerAPI.newDefinedName()
+	* const definedNameParam = fWorkbook.newDefinedNameBuilder()
 	*   .setRef('Sheet1!$A$1')
 	*   .setName('MyDefinedName')
 	*   .setComment('This is a comment')
 	*   .build();
-	* fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+	* fWorkbook.insertDefinedNameBuilder(definedNameParam);
 	* ```
 	*/
 	insertDefinedNameBuilder(param) {
-		param.unitId = this.getId();
 		this._commandService.syncExecuteCommand(_univerjs_sheets.SetDefinedNameCommand.id, param);
 	}
 	/**
@@ -7627,6 +7615,42 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
 		this._commandService.syncExecuteCommand(_univerjs_sheets.SetDefinedNameCommand.id, param);
 	}
 	/**
+	* Insert a defined name.
+	* @param {string} name The name of the defined name to insert
+	* @param {string} formulaOrRefString The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert
+	* @returns {FWorkbook} The current FWorkbook instance
+	* @example
+	* ```ts
+	* // The code below inserts a defined name
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
+	* ```
+	*/
+	insertDefinedName(name, formulaOrRefString) {
+		const definedNameParam = this.newDefinedNameBuilder().setName(name).setRef(formulaOrRefString).setScopeToWorkbook().build();
+		this.insertDefinedNameBuilder(definedNameParam);
+		return this;
+	}
+	/**
+	* Delete the defined name with the given name.
+	* @param {string} name The name of the defined name to delete
+	* @returns {boolean} true if the defined name was deleted, false otherwise
+	* @example
+	* ```ts
+	* // The code below deletes the defined name with the given name
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* fWorkbook.deleteDefinedName('MyDefinedName');
+	* ```
+	*/
+	deleteDefinedName(name) {
+		const definedName = this.getDefinedName(name);
+		if (definedName) {
+			definedName.delete();
+			return true;
+		}
+		return false;
+	}
+	/**
 	* Gets the registered range themes.
 	* @returns {string[]} The name list of registered range themes.
 	* @example
@@ -7854,7 +7878,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
 				this.fireEvent(this.Event.WorkbookDisposed, eventParams);
 			}
 		})));
-		this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookCreated, () => univerInstanceService.unitAdded$.subscribe((unit) => {
+		this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookCreated, () => univerInstanceService.unitAdded$.subscribe((event) => {
+			const { unit } = event;
 			if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
 				const workbook = unit;
 				const workbookUnit = injector.createInstance(FWorkbook, workbook);
@@ -8155,13 +8180,10 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
 		return this.getUniverSheet(id);
 	}
 	onUniverSheetCreated(callback) {
-		return (0, _univerjs_core.toDisposable)(this._univerInstanceService.getTypeOfUnitAdded$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).subscribe((workbook) => {
-			callback(this._injector.createInstance(FWorkbook, workbook));
+		return (0, _univerjs_core.toDisposable)(this._univerInstanceService.getTypeOfUnitAdded$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).subscribe((event) => {
+			callback(this._injector.createInstance(FWorkbook, event.unit));
 		}));
 	}
-	newDefinedName() {
-		return this._injector.createInstance(FDefinedNameBuilder);
-	}
 	getActiveSheet() {
 		const workbook = this.getActiveWorkbook();
 		if (!workbook) return null;