@univerjs/sheets 0.5.2 → 0.5.3-experimental.20250106-4af1f4e

package/lib/types/basics/interfaces/mutation-interface.d.ts

@@ -64,3 +64,10 @@ export interface IAddWorksheetMergeMutationParams {
     subUnitId: string;
     ranges: IRange[];
 }
+/** Params of AddWorksheetMergeMutation */
+export interface IWorksheetRangeThemeStyleMutationParams {
+    unitId: string;
+    subUnitId: string;
+    range: IRange;
+    themeName: string;
+}

package/lib/types/commands/commands/__tests__/range-template-command.sepc.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+export {};

package/lib/types/commands/commands/add-worksheet-merge.command.d.ts

@@ -9,4 +9,4 @@ export declare const AddWorksheetMergeCommand: ICommand;
 export declare const AddWorksheetMergeAllCommand: ICommand;
 export declare const AddWorksheetMergeVerticalCommand: ICommand;
 export declare const AddWorksheetMergeHorizontalCommand: ICommand;
-export declare function addMergeCellsUtil(injector: Injector, unitId: string, subUnitId: string, ranges: IRange[], defaultMerge: boolean): Promise<void>;
+export declare function addMergeCellsUtil(injector: Injector, unitId: string, subUnitId: string, ranges: IRange[], defaultMerge: boolean): void;

package/lib/types/commands/commands/add-worksheet-range-theme.command.d.ts

@@ -0,0 +1,2 @@
+import { ICommand } from '@univerjs/core';
+export declare const SetWorksheetRangeThemeStyleCommand: ICommand;

package/lib/types/commands/commands/delete-worksheet-range-theme.command.d.ts

@@ -0,0 +1,2 @@
+import { ICommand } from '@univerjs/core';
+export declare const DeleteWorksheetRangeThemeStyleCommand: ICommand;

package/lib/types/commands/commands/insert-row-col.command.d.ts

@@ -21,6 +21,7 @@ export declare const InsertRowCommandId = "sheet.command.insert-row";
  * @internal
  */
 export declare const InsertRowCommand: ICommand;
+export declare const InsertRowByRangeCommand: ICommand;
 export declare const InsertRowBeforeCommand: ICommand;
 export declare const InsertRowAfterCommand: ICommand;
 export interface IInsertColCommandParams {
@@ -32,5 +33,6 @@ export interface IInsertColCommandParams {
 }
 export declare const InsertColCommandId = "sheet.command.insert-col";
 export declare const InsertColCommand: ICommand<IInsertColCommandParams>;
+export declare const InsertColByRangeCommand: ICommand<IInsertColCommandParams>;
 export declare const InsertColBeforeCommand: ICommand;
 export declare const InsertColAfterCommand: ICommand;

package/lib/types/commands/commands/register-range-theme.command.d.ts

@@ -0,0 +1,7 @@
+import { ICommand } from '@univerjs/core';
+import { RangeThemeStyle } from '../../model/range-theme-util';
+export interface IRegisterWorksheetRangeThemeStyleCommandParams {
+    unitId: string;
+    rangeThemeStyle: RangeThemeStyle;
+}
+export declare const RegisterWorksheetRangeThemeStyleCommand: ICommand<IRegisterWorksheetRangeThemeStyleCommandParams>;

package/lib/types/commands/commands/remove-row-col.command.d.ts

@@ -5,12 +5,24 @@ export interface IRemoveRowColCommandParams {
 export interface IRemoveRowColCommandInterceptParams extends IRemoveRowColCommandParams {
     ranges?: IRange[];
 }
+export interface IRemoveRowByRangeCommandParams {
+    range: IRange;
+    unitId: string;
+    subUnitId: string;
+}
+export interface IRemoveColByRangeCommandParams {
+    range: IRange;
+    unitId: string;
+    subUnitId: string;
+}
 export declare const RemoveRowCommandId = "sheet.command.remove-row";
+export declare const RemoveRowByRangeCommand: ICommand<IRemoveRowByRangeCommandParams>;
 /**
  * This command would remove the selected rows. These selected rows can be non-continuous.
  */
 export declare const RemoveRowCommand: ICommand<IRemoveRowColCommandParams>;
 export declare const RemoveColCommandId = "sheet.command.remove-col";
+export declare const RemoveColByRangeCommand: ICommand<IRemoveColByRangeCommandParams>;
 /**
  * This command would remove the selected columns. These selected rows can be non-continuous.
  */

package/lib/types/commands/commands/unregister-range-theme.command.d.ts

@@ -0,0 +1,6 @@
+import { ICommand } from '@univerjs/core';
+export interface IUnregisterWorksheetRangeThemeStyleCommandParams {
+    unitId: string;
+    themeName: string;
+}
+export declare const UnregisterWorksheetRangeThemeStyleCommand: ICommand<IUnregisterWorksheetRangeThemeStyleCommandParams>;

package/lib/types/commands/mutations/add-worksheet-range-theme.mutation.d.ts

@@ -0,0 +1,9 @@
+import { IAccessor, IMutation } from '@univerjs/core';
+import { IWorksheetRangeThemeStyleMutationParams } from '../../basics/interfaces/mutation-interface';
+export declare const SetWorksheetRangeThemeStyleMutation: IMutation<IWorksheetRangeThemeStyleMutationParams>;
+export declare const SetWorksheetRangeThemeStyleMutationFactory: (accessor: IAccessor, params: IWorksheetRangeThemeStyleMutationParams) => {
+    unitId: string;
+    subUnitId: string;
+    range: import('@univerjs/core').IRange;
+    themeName: string;
+};

package/lib/types/commands/mutations/delete-worksheet-range-theme.mutation.d.ts

@@ -0,0 +1,9 @@
+import { IAccessor, IMutation } from '@univerjs/core';
+import { IWorksheetRangeThemeStyleMutationParams } from '../../basics/interfaces/mutation-interface';
+export declare const DeleteWorksheetRangeThemeStyleMutation: IMutation<IWorksheetRangeThemeStyleMutationParams>;
+export declare const DeleteWorksheetRangeThemeStyleMutationFactory: (accessor: IAccessor, params: IWorksheetRangeThemeStyleMutationParams) => {
+    unitId: string;
+    subUnitId: string;
+    range: import('@univerjs/core').IRange;
+    themeName: string;
+};

package/lib/types/commands/mutations/register-range-theme.mutation.d.ts

@@ -0,0 +1,8 @@
+import { IMutation } from '@univerjs/core';
+import { IRangeThemeStyleJSON } from '../../model/range-theme-util';
+export interface IRegisterWorksheetRangeThemeStyleMutationParams {
+    unitId: string;
+    themeName: string;
+    rangeThemeStyleJson: IRangeThemeStyleJSON;
+}
+export declare const RegisterWorksheetRangeThemeStyleMutation: IMutation<IRegisterWorksheetRangeThemeStyleMutationParams>;

package/lib/types/commands/mutations/unregister-range-theme-style.mutation.d.ts

@@ -0,0 +1,6 @@
+import { IMutation } from '@univerjs/core';
+export interface IUnregisterWorksheetRangeThemeStyleMutationParams {
+    unitId: string;
+    themeName: string;
+}
+export declare const UnregisterWorksheetRangeThemeStyleMutation: IMutation<IUnregisterWorksheetRangeThemeStyleMutationParams>;

package/lib/types/controllers/permission/sheet-permission-check.controller.d.ts

@@ -0,0 +1,33 @@
+import { IPermissionTypes, IRange, Disposable, DisposableCollection, ICommandService, IContextService, IPermissionService, IUniverInstanceService, LocaleService } from '@univerjs/core';
+import { IDefinedNamesService, LexerTreeBuilder } from '@univerjs/engine-formula';
+import { RangeProtectionRuleModel } from '../../model/range-protection-rule.model';
+import { WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission';
+import { SheetsSelectionsService } from '../../services/selections';
+export declare class SheetPermissionCheckController extends Disposable {
+    private readonly _commandService;
+    private readonly _univerInstanceService;
+    private readonly _permissionService;
+    private readonly _selectionManagerService;
+    private _rangeProtectionRuleModel;
+    private _worksheetProtectionRuleModel;
+    private readonly _localeService;
+    private readonly _lexerTreeBuilder;
+    private readonly _contextService;
+    private readonly _definedNamesService;
+    disposableCollection: DisposableCollection;
+    private _triggerPermissionUIEvent$;
+    triggerPermissionUIEvent$: import('rxjs').Observable<string>;
+    constructor(_commandService: ICommandService, _univerInstanceService: IUniverInstanceService, _permissionService: IPermissionService, _selectionManagerService: SheetsSelectionsService, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _localeService: LocaleService, _lexerTreeBuilder: LexerTreeBuilder, _contextService: IContextService, _definedNamesService: IDefinedNamesService);
+    blockExecuteWithoutPermission(errorMsg: string): void;
+    private _getPermissionCheck;
+    private _initialize;
+    private _commandExecutedListener;
+    private _permissionCheckWithInsertRangeMove;
+    private _permissionCheckByWorksheetCommand;
+    permissionCheckWithoutRange(permissionTypes: IPermissionTypes): boolean;
+    permissionCheckWithRanges(permissionTypes: IPermissionTypes, selectionRanges?: IRange[], unitId?: string, subUnitId?: string): boolean;
+    private _permissionCheckByMoveCommand;
+    private _permissionCheckByMoveRangeCommand;
+    private _permissionCheckBySetRangeValue;
+    private _permissionCheckWithFormula;
+}

package/lib/types/controllers/permission/sheet-permission-init.controller.d.ts

@@ -0,0 +1,29 @@
+import { Disposable, IAuthzIoService, ICommandService, IPermissionService, IUndoRedoService, IUniverInstanceService, UserManagerService } from '@univerjs/core';
+import { RangeProtectionRuleModel } from '../../model/range-protection-rule.model';
+import { RangeProtectionCache } from '../../model/range-protection.cache';
+import { WorksheetProtectionPointModel, WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission';
+import { SheetInterceptorService } from '../../services/sheet-interceptor/sheet-interceptor.service';
+export declare class SheetPermissionInitController extends Disposable {
+    private readonly _univerInstanceService;
+    private _permissionService;
+    private _authzIoService;
+    private _rangeProtectionRuleModel;
+    private _worksheetProtectionRuleModel;
+    private _userManagerService;
+    private _worksheetProtectionPointRuleModel;
+    private _sheetInterceptorService;
+    private _undoRedoService;
+    private _commandService;
+    private _rangeProtectionCache;
+    constructor(_univerInstanceService: IUniverInstanceService, _permissionService: IPermissionService, _authzIoService: IAuthzIoService, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _userManagerService: UserManagerService, _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel, _sheetInterceptorService: SheetInterceptorService, _undoRedoService: IUndoRedoService, _commandService: ICommandService, _rangeProtectionCache: RangeProtectionCache);
+    private _initRangePermissionFromSnapshot;
+    private _initRangePermissionChange;
+    initWorkbookPermissionChange(_unitId?: string): Promise<void>;
+    private _initWorkbookPermissionFromSnapshot;
+    private _initWorksheetPermissionChange;
+    private _initWorksheetPermissionPointsChange;
+    private _initWorksheetPermissionFromSnapshot;
+    private _initUserChange;
+    refreshPermission(unitId: string, permissionId: string): void;
+    private _refreshPermissionByCollaCreate;
+}

package/lib/types/controllers/permission/sheet-permission-view-model.controller.d.ts

@@ -0,0 +1,13 @@
+import { Disposable, IPermissionService } from '@univerjs/core';
+import { RangeProtectionCache } from '../../model/range-protection.cache';
+import { WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission';
+import { SheetInterceptorService } from '../../services/sheet-interceptor/sheet-interceptor.service';
+export declare class SheetPermissionViewModelController extends Disposable {
+    private _permissionService;
+    private _worksheetProtectionRuleModel;
+    private _sheetInterceptorService;
+    private _rangeProtectionCache;
+    constructor(_permissionService: IPermissionService, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _sheetInterceptorService: SheetInterceptorService, _rangeProtectionCache: RangeProtectionCache);
+    private _initViewModelByRangeInterceptor;
+    private _initViewModelBySheetInterceptor;
+}

package/lib/types/facade/f-defined-name.d.ts

@@ -7,12 +7,12 @@ export declare class FDefinedNameBuilder {
     constructor();
     /**
      * Sets the name of the defined name builder.
-     * @param name  The name of the defined name.
-     * @returns The defined name builder.
+     * @param {string} name The name of the defined name.
+     * @returns {FDefinedNameBuilder} The defined name builder.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
-     * const definedNameBuilder = UniverAPI.newDefinedName()
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
      *    .setName('MyDefinedName')
      *  .build();
      * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -21,12 +21,12 @@ export declare class FDefinedNameBuilder {
     setName(name: string): FDefinedNameBuilder;
     /**
      * Sets the formula of the defined name builder.
-     * @param formula The formula of the defined name.
-     * @returns The defined name builder.
+     * @param {string }formula The formula of the defined name.
+     * @returns {FDefinedNameBuilder} The defined name builder.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
-     * const definedNameBuilder = UniverAPI.newDefinedName()
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
      *  .setFormula('SUM(Sheet1!$A$1)')
      * .setName('MyDefinedName')
      * .build();
@@ -36,12 +36,12 @@ export declare class FDefinedNameBuilder {
     setFormula(formula: string): FDefinedNameBuilder;
     /**
      * Sets the reference of the defined name builder.
-     * @param refString The reference of the defined name.
-     * @returns The defined name builder.
+     * @param {string} a1Notation The reference of the defined name.
+     * @returns {FDefinedNameBuilder} The defined name builder.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
-     * const definedNameBuilder = UniverAPI.newDefinedName()
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
      *  .setRef('Sheet1!$A$1')
      * .build();
      * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -50,15 +50,15 @@ export declare class FDefinedNameBuilder {
     setRef(a1Notation: string): FDefinedNameBuilder;
     /**
      * Sets the reference of the defined name builder by range .
-     * @param row The start row of the range.
-     * @param column The start column of the range.
-     * @param numRows The number of rows in the range.
-     * @param numColumns The number of columns in the range.
-     * @returns The defined name builder.
+     * @param {number} row The start row of the range.
+     * @param {number} column The start column of the range.
+     * @param {number} numRows The number of rows in the range.
+     * @param {number} numColumns The number of columns in the range.
+     * @returns {FDefinedNameBuilder} The defined name builder.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
-     * const definedNameBuilder = UniverAPI.newDefinedName()
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
      *  .setRefByRange(1, 3, 2, 5)
      * .build();
      * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -67,12 +67,12 @@ export declare class FDefinedNameBuilder {
     setRefByRange(row: number, column: number, numRows: number, numColumns: number): FDefinedNameBuilder;
     /**
      * Sets the comment of the defined name builder.
-     * @param comment The comment of the defined name.
-     * @returns The defined name builder.
+     * @param {string} comment The comment of the defined name.
+     * @returns {FDefinedNameBuilder} The defined name builder.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
-     * const definedNameBuilder = UniverAPI.newDefinedName()
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
      *  .setComment('This is a comment')
      * .build();
      * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -81,12 +81,12 @@ export declare class FDefinedNameBuilder {
     setComment(comment: string): FDefinedNameBuilder;
     /**
      * Sets the hidden status of the defined name builder.
-     * @param hidden The hidden status of the defined name.
-     * @returns The defined name builder.
+     * @param {boolean} hidden The hidden status of the defined name.
+     * @returns {FDefinedNameBuilder} The defined name builder.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
-     * const definedNameBuilder = UniverAPI.newDefinedName()
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
      *  .setHidden(true)
      * .build();
      * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -95,11 +95,11 @@ export declare class FDefinedNameBuilder {
     setHidden(hidden: boolean): FDefinedNameBuilder;
     /**
      * Builds the defined name.
-     * @returns The defined name mutation parameter.
+     * @returns {FDefinedNameBuilder} The defined name mutation parameter.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
-     * const definedNameBuilder = UniverAPI.newDefinedName()
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
      *  .setRef('Sheet1!$A$1')
      *  .setName('MyDefinedName')
      *  .build();
@@ -124,10 +124,10 @@ export declare class FDefinedName extends FBase {
     private _apply;
     /**
      * Gets the name of the defined name.
-     * @returns The name of the defined name.
+     * @returns {string} The name of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * console.log(definedName.getName());
      * ```
@@ -135,10 +135,10 @@ export declare class FDefinedName extends FBase {
     getName(): string;
     /**
      * Sets the name of the defined name.
-     * @param name The name of the defined name.
+     * @param {string} name The name of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedName('MyDefinedName');
      * definedName.setName('NewDefinedName');
      * ```
@@ -146,10 +146,10 @@ export declare class FDefinedName extends FBase {
     setName(name: string): void;
     /**
      * Sets the formula of the defined name.
-     * @param formula The formula of the defined name.
+     * @param {string} formula The formula of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedName('MyDefinedName');
      * definedName.setFormula('SUM(Sheet1!$A$1)');
      * ```
@@ -157,10 +157,10 @@ export declare class FDefinedName extends FBase {
     setFormula(formula: string): void;
     /**
      * Sets the reference of the defined name.
-     * @param refString The reference of the defined name.
+     * @param {string} refString The reference of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * definedName.setRef('Sheet1!$A$1');
      * ```
@@ -168,10 +168,10 @@ export declare class FDefinedName extends FBase {
     setRef(refString: string): void;
     /**
      * Gets the reference of the defined name.
-     * @returns The reference of the defined name.
+     * @returns {string} The reference of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * console.log(definedName.getFormulaOrRefString());
      * ```
@@ -179,13 +179,13 @@ export declare class FDefinedName extends FBase {
     getFormulaOrRefString(): string;
     /**
      * Sets the reference of the defined name by range.
-     * @param row The start row of the range.
-     * @param column The start column of the range.
-     * @param numRows The number of rows in the range.
-     * @param numColumns The number of columns in the range.
+     * @param {number} row The start row of the range.
+     * @param {number} column The start column of the range.
+     * @param {number} numRows The number of rows in the range.
+     * @param {number} numColumns The number of columns in the range.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * definedName.setRefByRange(1, 3, 2, 5);
      * ```
@@ -193,10 +193,10 @@ export declare class FDefinedName extends FBase {
     setRefByRange(row: number, column: number, numRows: number, numColumns: number): void;
     /**
      * Gets the comment of the defined name.
-     * @returns The comment of the defined name.
+     * @returns {string | undefined} The comment of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * console.log(definedName.getComment());
      * ```
@@ -204,10 +204,10 @@ export declare class FDefinedName extends FBase {
     getComment(): string | undefined;
     /**
      * Sets the comment of the defined name.
-     * @param comment The comment of the defined name.
+     * @param {string} comment The comment of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * definedName.setComment('This is a comment');
      * ```
@@ -215,10 +215,10 @@ export declare class FDefinedName extends FBase {
     setComment(comment: string): void;
     /**
      * Sets the scope of the defined name to the worksheet.
-     * @param worksheet The worksheet to set the scope to.
+     * @param {FWorksheet} worksheet The worksheet to set the scope to.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const worksheet = workbook.getWorksheets[0];
      * const definedName = workbook.getDefinedNames[0];
      * definedName.setScopeToWorksheet(worksheet);
@@ -229,7 +229,7 @@ export declare class FDefinedName extends FBase {
      * Sets the scope of the defined name to the workbook.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * definedName.setScopeToWorkbook();
      * ```
@@ -237,10 +237,10 @@ export declare class FDefinedName extends FBase {
     setScopeToWorkbook(): void;
     /**
      * Sets the hidden status of the defined name.
-     * @param hidden The hidden status of the defined name.
+     * @param {boolean} hidden The hidden status of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * definedName.setHidden(true);
      * ```
@@ -250,7 +250,7 @@ export declare class FDefinedName extends FBase {
      * Deletes the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * definedName.delete();
      * ```
@@ -258,10 +258,10 @@ export declare class FDefinedName extends FBase {
     delete(): void;
     /**
      * Gets the local sheet id of the defined name.
-     * @returns The local sheet id of the defined name.
+     * @returns {string | undefined} The local sheet id of the defined name.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * console.log(definedName.getLocalSheetId());
      * ```
@@ -269,10 +269,10 @@ export declare class FDefinedName extends FBase {
     getLocalSheetId(): string | undefined;
     /**
      * Checks if the defined name is in the workbook scope.
-     * @returns True if the defined name is in the workbook scope, false otherwise.
+     * @returns {boolean} True if the defined name is in the workbook scope, false otherwise.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * console.log(definedName.isWorkbookScope());
      * ```
@@ -280,10 +280,10 @@ export declare class FDefinedName extends FBase {
     isWorkbookScope(): boolean;
     /**
      * Converts the defined name to a defined name builder.
-     * @returns The defined name builder.
+     * @returns {FDefinedNameBuilder} The defined name builder.
      * @example
      * ```ts
-     * const workbook = UniverAPI.getActiveWorkbook();
+     * const workbook = univerAPI.getActiveWorkbook();
      * const definedName = workbook.getDefinedNames[0];
      * const definedNameBuilder = definedName.toBuilder();
      * const param definedNameBuilder.setName('NewDefinedName').setFormula('SUM(Sheet1!$A$1)').build();

package/lib/types/facade/f-event.d.ts

@@ -0,0 +1,30 @@
+import { IEventBase, IWorksheetData, FEventName } from '@univerjs/core';
+import { FWorkbook } from './f-workbook';
+import { FWorksheet } from './f-worksheet';
+export interface IFSheetEventMixin {
+    get SheetCreated(): 'SheetCreated';
+    get BeforeSheetCreate(): 'BeforeSheetCreate';
+}
+export declare class FSheetEventName extends FEventName implements IFSheetEventMixin {
+    get SheetCreated(): 'SheetCreated';
+    get BeforeSheetCreate(): 'BeforeSheetCreate';
+}
+export interface IBeforeSheetCreateEventParams extends IEventBase {
+    workbook: FWorkbook;
+    index?: number;
+    sheet?: IWorksheetData;
+}
+export interface ISheetCreatedEventParams extends IEventBase {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+}
+export interface ISheetEventParamConfig {
+    SheetCreated: ISheetCreatedEventParams;
+    BeforeSheetCreate: IBeforeSheetCreateEventParams;
+}
+declare module '@univerjs/core' {
+    interface FEventName extends IFSheetEventMixin {
+    }
+    interface IEventParamConfig extends ISheetEventParamConfig {
+    }
+}

package/lib/types/facade/f-permission.d.ts

@@ -145,10 +145,4 @@ export declare class FPermission extends FBase {
      * @param {IRange[]} ranges - The array of new ranges to be set for the range protection rule.
      */
     setRangeProtectionRanges(unitId: string, subUnitId: string, ruleId: string, ranges: IRange[]): void;
-    /**
-     * Set visibility of unauthorized pop-up window
-     *
-     * @param {boolean} visible
-     */
-    setPermissionDialogVisible(visible: boolean): void;
 }