@univerjs/sheets 1.0.0-rc.0 → 1.0.0

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

@@ -16,14 +16,16 @@
 import type { CellValue, CustomData, IColumnRange, IFreeze, IObjectArrayPrimitiveType, IRange, IRowRange, IStyleData, Nullable, Workbook, Worksheet } from '@univerjs/core';
 import type { FDefinedName } from './f-defined-name';
 import type { FWorkbook } from './f-workbook';
-import { BooleanNumber, ICommandService, ILogService, Injector } from '@univerjs/core';
+import { BooleanNumber, ICommandService, ILogService, Injector, WorksheetHiddenState } from '@univerjs/core';
 import { FBaseInitialable } from '@univerjs/core/facade';
 import { SheetsSelectionsService } from '@univerjs/sheets';
 import { FRange } from './f-range';
 import { FSelection } from './f-selection';
 import { FWorksheetPermission } from './permission/f-worksheet-permission';
 export interface IFacadeClearOptions {
+    /** Clears only content when true and `formatOnly` is false. */
     contentsOnly?: boolean;
+    /** Clears only formatting when true and `contentsOnly` is false. */
     formatOnly?: boolean;
 }
 /**
@@ -49,6 +51,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @param {ICommandService} _commandService - The command service
      */
     constructor(_fWorkbook: FWorkbook, _workbook: Workbook, _worksheet: Worksheet, _injector: Injector, _selectionManagerService: SheetsSelectionsService, _logService: ILogService, _commandService: ICommandService);
+    /** Releases this facade's resources. Use `univerAPI.disposeUnit()` to unload the owning unit. */
     dispose(): void;
     /**
      * Get the worksheet instance.
@@ -112,7 +115,7 @@ export declare class FWorksheet extends FBaseInitialable {
     getSheetName(): string;
     /**
      * Get the current selection of the worksheet.
-     * @returns {FSelection} return the current selections of the worksheet or null if there is no selection.
+     * @returns {FSelection | null} The current selections, or `null` when no selection data is available.
      * @example
      * ```typescript
      * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
@@ -124,7 +127,7 @@ export declare class FWorksheet extends FBaseInitialable {
     getSelection(): FSelection | null;
     /**
      * Get the default style of the worksheet.
-     * @returns {IStyleData} Default style of the worksheet.
+     * @returns {Nullable<IStyleData> | string} The default style object or style ID, or a nullish value when no default style is set.
      * @example
      * ```typescript
      * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
@@ -172,7 +175,7 @@ export declare class FWorksheet extends FBaseInitialable {
     getColumnDefaultStyle(index: number, keepRaw?: boolean): Nullable<IStyleData> | string;
     /**
      * Set the default style of the worksheet
-     * @param {string} style - The style to set
+     * @param {string | Nullable<IStyleData>} style - A style ID or style object, or `null` to clear the default style.
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
@@ -185,8 +188,8 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     setDefaultStyle(style: string | Nullable<IStyleData>): FWorksheet;
     /**
-     * Set the default style of the worksheet row
-     * @param {number} index - The row index
+     * Set the default style of the worksheet column
+     * @param {number} index - The zero-based column index
      * @param {string | Nullable<IStyleData>} style - The style name or style data
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
@@ -201,8 +204,8 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet;
     /**
-     * Set the default style of the worksheet column
-     * @param {number} index - The column index
+     * Set the default style of the worksheet row
+     * @param {number} index - The zero-based row index
      * @param {string | Nullable<IStyleData>} style - The style name or style data
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
@@ -340,7 +343,7 @@ export declare class FWorksheet extends FBaseInitialable {
     /**
      * Inserts one or more consecutive blank rows in a sheet starting at the specified location.
      * @param {number} rowIndex - The existing row before which rows are inserted. The index is zero-based and must be between 0 and `getMaxRows() - 1`.
-     * @param {number} numRows - The positive number of rows to insert.
+     * @param {number} [numRows] - The positive number of rows to insert.
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
@@ -467,7 +470,7 @@ export declare class FWorksheet extends FBaseInitialable {
     /**
      * Hides one or more consecutive rows starting at the given index. Use 0-index for this method
      * @param {number} rowIndex - The starting index of the rows to hide
-     * @param {number} numRow - The number of rows to hide
+     * @param {number} [numRow] - The number of rows to hide
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
@@ -498,9 +501,9 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     unhideRow(row: FRange): FWorksheet;
     /**
-     * Scrolling sheet to make specific rows visible.
+     * Unhides one or more consecutive rows starting at the given zero-based index.
      * @param {number} rowIndex - The starting index of the rows
-     * @param {number} numRows - The number of rows
+     * @param {number} [numRows] - The number of rows
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
@@ -532,7 +535,7 @@ export declare class FWorksheet extends FBaseInitialable {
     /**
      * Make certain row wrap and auto height.
      * @param {number} rowPosition - The row position to change.
-     * @param {BooleanNumber} auto - Whether to auto fit the row height.
+     * @param {BooleanNumber} [auto] - Whether to auto fit the row height.
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```ts
@@ -664,7 +667,7 @@ export declare class FWorksheet extends FBaseInitialable {
     /**
      * Inserts one or more consecutive blank columns in a sheet starting at the specified location.
      * @param {number} columnIndex - The index indicating where to insert a column, starting at 0 for the first column
-     * @param {number} numColumns - The number of columns to insert
+     * @param {number} [numColumns] - The number of columns to insert
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
@@ -791,7 +794,7 @@ export declare class FWorksheet extends FBaseInitialable {
     /**
      * Hides one or more consecutive columns starting at the given index. Use 0-index for this method
      * @param {number} columnIndex - The starting index of the columns to hide
-     * @param {number} numColumn - The number of columns to hide
+     * @param {number} [numColumn] - The number of columns to hide
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
@@ -824,7 +827,7 @@ export declare class FWorksheet extends FBaseInitialable {
     /**
      * Show one or more consecutive columns starting at the given index. Use 0-index for this method
      * @param {number} columnIndex - The starting index of the columns to unhide
-     * @param {number} numColumns - The number of columns to unhide
+     * @param {number} [numColumns] - The number of columns to unhide
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
@@ -881,7 +884,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * fRange.setValue('Whenever it is a damp, drizzly November in my soul...');
      *
      * // Set the column A to a width which fits the text
-     * fWorksheet.autoResizeColumn(0);
+     * fWorksheet.autoResizeColumns(0);
      *
      * // Get the width of the column A
      * console.log(fWorksheet.getColumnWidth(0));
@@ -1209,7 +1212,7 @@ export declare class FWorksheet extends FBaseInitialable {
     getGridLinesColor(): string | undefined;
     /**
      * Sets the sheet tab color.
-     * @param {string|null|undefined} color - A color code in CSS notation (like '#ffffff' or 'white'), or null to reset the tab color.
+     * @param {string} color - A color in CSS notation, such as '#ffffff' or 'white'.
      * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
@@ -1223,8 +1226,7 @@ export declare class FWorksheet extends FBaseInitialable {
     setTabColor(color: string): FWorksheet;
     /**
      * Get the tab color of the sheet.
-     * @returns {string} The tab color of the sheet or undefined.
-     * The default color is css style property 'unset'.
+     * @returns {string | undefined} The tab color, or `undefined` when no color is set.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -1261,7 +1263,7 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     showSheet(): FWorksheet;
     /**
-     * Returns true if the sheet is currently hidden.
+     * Returns true for both HIDDEN and VERY_HIDDEN sheets.
      * @returns {boolean} True if the sheet is hidden; otherwise, false.
      * @example
      * ```ts
@@ -1272,6 +1274,18 @@ export declare class FWorksheet extends FBaseInitialable {
      * ```
      */
     isSheetHidden(): boolean;
+    /**
+     * Returns 0 (visible), 1 (hidden), or 2 (very hidden).
+     * @example fWorksheet.getHiddenState() === univerAPI.Enum.WorksheetHiddenState.VERY_HIDDEN
+     */
+    getHiddenState(): WorksheetHiddenState;
+    /**
+     * Changes the persisted hiding state through an undoable command.
+     * VERY_HIDDEN removes the sheet from Unhide UI; showSheet() can reveal it through the API.
+     * The last visible sheet cannot be hidden. Existing isSheetHidden() stays a boolean predicate.
+     * @example fWorksheet.setHiddenState(univerAPI.Enum.WorksheetHiddenState.VERY_HIDDEN)
+     */
+    setHiddenState(hidden: WorksheetHiddenState): FWorksheet;
     /**
      * Sets the sheet name.
      * @param {string} name - The new name for the sheet.
@@ -1313,10 +1327,11 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     getIndex(): number;
     /**
-     * Clears the sheet of content and formatting information.Or Optionally clears only the contents or only the formatting.
+     * Clears the sheet content and formatting, or only one of them as specified by the options.
+     * Both content and formatting are cleared when both flags are true or both are false.
      * @param {IFacadeClearOptions} [options] - Options for clearing the sheet. If not provided, the contents and formatting are cleared both.
-     * @param {boolean} [options.contentsOnly] - If true, the contents of the sheet are cleared. If false, the contents and formatting are cleared. Default is false.
-     * @param {boolean} [options.formatOnly] - If true, the formatting of the sheet is cleared. If false, the contents and formatting are cleared. Default is false.
+     * @param {boolean} [options.contentsOnly] - If true, the contents of the sheet are cleared. Effective only when `formatOnly` is false. Defaults to false.
+     * @param {boolean} [options.formatOnly] - Clears only formatting when true and `contentsOnly` is false. Defaults to false.
      * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
@@ -1373,8 +1388,8 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     getDataRange(): FRange;
     /**
-     * Returns the column index of the last column that contains content.
-     * @returns {number} the column index of the last column that contains content.
+     * Returns the zero-based index of the last column with stored cell data, including formatting-only cells.
+     * @returns {number} The last stored column index, or 0 for an empty sheet.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -1388,8 +1403,8 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     getLastColumn(): number;
     /**
-     * Returns the row index of the last row that contains content.
-     * @returns {number} the row index of the last row that contains content.
+     * Returns the zero-based index of the last row with stored cell data, including formatting-only cells.
+     * @returns {number} The last stored row index, or 0 for an empty sheet.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();

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

@@ -53,7 +53,7 @@ export declare class FRangePermission extends FBase {
     isProtected(): boolean;
     /**
      * Protect the current range.
-     * @param {IRangeProtectionOptions} options Protection options.
+     * @param {IRangeProtectionOptions} [options] Protection options.
      * @returns {Promise<FRangeProtectionRule>} The created protection rule.
      * @example
      * ```ts

package/lib/types/facade/permission/f-range-protection-rule.d.ts

@@ -56,7 +56,7 @@ export declare class FRangeProtectionRule {
     /**
      * Update the protected ranges.
      * @param {FRange[]} ranges New ranges to protect.
-     * @returns {Promise<void>} A promise that resolves when the ranges are updated.
+     * @returns {Promise<boolean>} A promise resolving to whether the protected ranges were updated.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -74,7 +74,7 @@ export declare class FRangeProtectionRule {
     updateRanges(ranges: FRange[]): Promise<boolean>;
     /**
      * Delete the current protection rule.
-     * @returns {Promise<void>} A promise that resolves when the rule is removed.
+     * @returns {Promise<boolean>} A promise resolving to whether the rule was removed.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();

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

@@ -116,7 +116,7 @@ export declare class FWorkbookPermission extends FBase {
     getSnapshot(): WorkbookPermissionSnapshot;
     /**
      * Set multiple collaborators at once (replaces existing collaborators).
-     * @param {Array<{ user: IUser; role: UnitRole }>} collaborators Array of collaborators with user information and role.
+     * @param {Array<{ user: ICollaboratorUser; role: UnitRole }>} collaborators Array of collaborators with user information and role.
      * @returns {Promise<void>} A promise that resolves when the collaborators are set.
      * @example
      * ```ts
@@ -140,7 +140,7 @@ export declare class FWorkbookPermission extends FBase {
     }>): Promise<void>;
     /**
      * Add a single collaborator.
-     * @param {IUser} user The user information (userID, name, avatar).
+     * @param {ICollaboratorUser} user The user information (userID, name, avatar).
      * @param {UnitRole} role The role to assign.
      * @returns {Promise<void>} A promise that resolves when the collaborator is added.
      * @example
@@ -156,7 +156,7 @@ export declare class FWorkbookPermission extends FBase {
     addCollaborator(user: ICollaboratorUser, role: UnitRole): Promise<void>;
     /**
      * Update an existing collaborator's role and information.
-     * @param {IUser} user The updated user information (userID, name, avatar).
+     * @param {ICollaboratorUser} user The updated user information (userID, name, avatar).
      * @param {UnitRole} role The new role to assign.
      * @returns {Promise<void>} A promise that resolves when the collaborator is updated.
      * @example

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

@@ -56,7 +56,7 @@ export declare class FWorksheetPermission extends FBase {
     /**
      * Create worksheet protection with collaborators support.
      * This must be called before setting permission points for collaboration to work.
-     * @param {IWorksheetProtectionOptions} options Protection options including allowed users.
+     * @param {IWorksheetProtectionOptions} [options] Protection options including allowed users.
      * @returns {Promise<string>} The permissionId for the created protection.
      * @example
      * ```ts
@@ -79,7 +79,7 @@ export declare class FWorksheetPermission extends FBase {
     /**
      * Remove worksheet protection.
      * This deletes the protection rule and resets all permission points to allowed.
-     * @returns {Promise<void>} A promise that resolves when protection is removed.
+     * @returns {Promise<boolean>} A promise resolving to whether protection was removed; also resolves to `true` if already unprotected.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -190,6 +190,7 @@ export declare class FWorksheetPermission extends FBase {
      * if (fWorksheet.getWorksheetPermission().canView()) {
      *   console.log('Worksheet is viewable');
      * }
+     * ```
      */
     canView(): boolean;
     /**
@@ -285,7 +286,7 @@ export declare class FWorksheetPermission extends FBase {
     /**
      * Remove multiple protection rules at once.
      * @param {string[]} ruleIds Array of rule IDs to remove.
-     * @returns {Promise<void>} A promise that resolves when the rules are removed.
+     * @returns {Promise<boolean>} A promise resolving to whether the rules were removed; also resolves to `true` for an empty ID list.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -322,7 +323,7 @@ export declare class FWorksheetPermission extends FBase {
      * Debug cell permission information.
      * @param {number} row Row index.
      * @param {number} col Column index.
-     * @returns {FRangeProtectionRule | undefined} Debug information about which rules affect this cell, or null if no rules apply.
+     * @returns {Promise<FRangeProtectionRule | undefined>} A promise resolving to the protection rule affecting this cell, or `undefined` if no range protection rule applies.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();

package/lib/types/facade/utils.d.ts

@@ -16,6 +16,7 @@
 import type { IRange, IRangeWithCoord, Worksheet } from '@univerjs/core';
 import { HorizontalAlign, VerticalAlign } from '@univerjs/core';
 export type FDefaultAlignment = 'general';
+/** Horizontal alignment accepted by the Facade API. `normal` means right alignment. */
 export type FHorizontalAlignment = 'left' | 'center' | 'normal';
 export type FVerticalAlignment = 'top' | 'middle' | 'bottom';
 /**

package/lib/types/index.d.ts

@@ -185,7 +185,7 @@ export { FactorySetRangeProtectionMutation, SetRangeProtectionMutation, } from '
 export type { ISetRangeProtectionMutationParams } from './commands/mutations/set-range-protection.mutation';
 export { SetRangeThemeMutation } from './commands/mutations/set-range-theme.mutation';
 export type { ISetRangeThemeMutationParams } from './commands/mutations/set-range-theme.mutation';
-export { SetRangeValuesMutation, SetRangeValuesUndoMutationFactory, } from './commands/mutations/set-range-values.mutation';
+export { prepareSetRangeValuesMutation, SetRangeValuesMutation, SetRangeValuesUndoMutationFactory, } from './commands/mutations/set-range-values.mutation';
 export type { ISetRangeValuesMutationParams, ISetRangeValuesRangeMutationParams, } from './commands/mutations/set-range-values.mutation';
 export { SetRowDataMutation, SetRowDataMutationFactory } from './commands/mutations/set-row-data.mutation';
 export type { ISetRowDataMutationParams } from './commands/mutations/set-row-data.mutation';

package/lib/types/model/range-protection-render.model.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+import type { IRange } from '@univerjs/core';
+import type { UnitAction } from '@univerjs/protocol';
+import { IPermissionService } from '@univerjs/core';
+import { RangeProtectionRuleModel } from './range-protection-rule.model';
+export type ICellPermission = Record<UnitAction, boolean> & {
+    ruleId?: string;
+    ranges?: IRange[];
+};
+export declare class RangeProtectionRenderModel {
+    private _selectionProtectionRuleModel;
+    private _permissionService;
+    private _cache;
+    constructor(_selectionProtectionRuleModel: RangeProtectionRuleModel, _permissionService: IPermissionService);
+    private _init;
+    private _createKey;
+    getCellInfo(unitId: string, subUnitId: string, row: number, col: number): ICellPermission[];
+    clear(): void;
+}

package/lib/types/model/range-protection-rule.model.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 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.
+ */
+import type { IDisposable, IRange } from '@univerjs/core';
+import type { UnitObject } from '@univerjs/protocol';
+export declare enum ViewStateEnum {
+    OthersCanView = "othersCanView",
+    NoOneElseCanView = "noOneElseCanView"
+}
+export declare enum EditStateEnum {
+    DesignedUserCanEdit = "designedUserCanEdit",
+    OnlyMe = "onlyMe"
+}
+export interface IRangeProtectionRule {
+    ranges: IRange[];
+    permissionId: string;
+    id: string;
+    description?: string;
+    unitType: UnitObject;
+    unitId: string;
+    subUnitId: string;
+    viewState: ViewStateEnum;
+    editState: EditStateEnum;
+}
+export type IObjectModel = Record<string, Record<string, IRangeProtectionRule[]>>;
+export type IModel = Map<string, Map<string, Map<string, IRangeProtectionRule>>>;
+export interface IRuleChange {
+    unitId: string;
+    subUnitId: string;
+    rule: IRangeProtectionRule;
+    oldRule?: IRangeProtectionRule;
+    type: IRuleChangeType;
+}
+type IRuleChangeType = 'add' | 'set' | 'delete';
+export declare class RangeProtectionRuleModel implements IDisposable {
+    /**
+     * Map<unitId, Map<subUnitId, Map<ruleId, IRangeProtectionRule>>>
+     */
+    private _model;
+    private readonly _ruleChange$;
+    readonly ruleChange$: import("rxjs").Observable<IRuleChange>;
+    private _ruleRefresh$;
+    ruleRefresh$: import("rxjs").Observable<string>;
+    dispose(): void;
+    ruleRefresh(id: string): void;
+    private _rangeRuleInitStateChange;
+    rangeRuleInitStateChange$: import("rxjs").Observable<boolean>;
+    getRangeRuleInitState(): boolean;
+    changeRuleInitState(state: boolean): void;
+    addRule(unitId: string, subUnitId: string, rule: IRangeProtectionRule): void;
+    deleteRule(unitId: string, subUnitId: string, id: string): void;
+    setRule(unitId: string, subUnitId: string, id: string, rule: IRangeProtectionRule): void;
+    getRule(unitId: string, subUnitId: string, id: string): IRangeProtectionRule | undefined;
+    getSubunitRuleList(unitId: string, subUnitId: string): IRangeProtectionRule[];
+    getSubunitRuleListLength(unitId: string, subUnitId: string): number;
+    private _ensureRuleMap;
+    toObject(): IObjectModel;
+    fromObject(obj: IObjectModel): void;
+    deleteUnitModel(unitId: string): void;
+    createRuleId(unitId: string, subUnitId: string): string;
+    getTargetByPermissionId(unitId: string, permissionId: string): string[] | null;
+}
+export {};

package/lib/types/model/range-protection.cache.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+import type { IRange } from '@univerjs/core';
+import { Disposable, IPermissionService, IUniverInstanceService } from '@univerjs/core';
+import { UnitAction } from '@univerjs/protocol';
+import { RangeProtectionRuleModel } from './range-protection-rule.model';
+export declare class RangeProtectionCache extends Disposable {
+    private readonly _ruleModel;
+    private readonly _permissionService;
+    private readonly _univerInstanceService;
+    private readonly _cellRuleCache;
+    private readonly _permissionIdCache;
+    private readonly _cellInfoCache;
+    private readonly _rowInfoCache;
+    private readonly _colInfoCache;
+    constructor(_ruleModel: RangeProtectionRuleModel, _permissionService: IPermissionService, _univerInstanceService: IUniverInstanceService);
+    private _initCache;
+    private _initUpdateCellInfoCache;
+    private _initUpdateCellRuleCache;
+    private _ensureRuleMap;
+    private _ensureCellInfoMap;
+    private _ensureRowColInfoMap;
+    private _addCellRuleCache;
+    private _deleteCellRuleCache;
+    private _getSelectionActions;
+    reBuildCache(unitId: string, subUnitId: string): void;
+    getRowPermissionInfo(unitId: string, subUnitId: string, row: number, types: UnitAction[]): boolean;
+    getColPermissionInfo(unitId: string, subUnitId: string, col: number, types: UnitAction[]): boolean;
+    private _initUpdateRowColInfoCache;
+    getCellInfo(unitId: string, subUnitId: string, row: number, col: number): (Partial<Record<UnitAction, boolean>> & {
+        ruleId?: string;
+        ranges?: IRange[];
+    }) | {
+        ruleId: string;
+        ranges: IRange[];
+        1: boolean;
+        0: boolean;
+        2: boolean;
+        42: boolean;
+    } | undefined;
+    deleteUnit(unitId: string): void;
+}

package/lib/types/model/range-theme-model.d.ts

@@ -0,0 +1,102 @@
+/**
+ * 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.
+ */
+import type { IRange, Nullable } from '@univerjs/core';
+import type { IRangeThemeStyleItem, IRangeThemeStyleJSON } from './range-theme-util';
+import { Disposable, IResourceManagerService, IUniverInstanceService } from '@univerjs/core';
+import { SheetInterceptorService } from '../services/sheet-interceptor/sheet-interceptor.service';
+import { RangeThemeStyle } from './range-theme-util';
+export interface IRangeThemeRangeInfo {
+    range: IRange;
+    unitId: string;
+    subUnitId: string;
+}
+export interface IRangeThemeStyleRule {
+    rangeInfo: IRangeThemeRangeInfo;
+    themeName: string;
+}
+interface ISheetRangeThemeModelJSON {
+    rangeThemeStyleRuleMap: Record<string, IRangeThemeStyleRule>;
+    rangeThemeStyleMapJson: Record<string, IRangeThemeStyleJSON>;
+}
+export declare class SheetRangeThemeModel extends Disposable {
+    private _sheetInterceptorService;
+    private _resourceManagerService;
+    private readonly _univerInstanceService;
+    private _rangeThemeStyleMap;
+    private _rangeThemeStyleRuleMap;
+    private _rTreeCollection;
+    private _defaultRangeThemeMap;
+    /**
+     * This map is used to cache zebra crossing toggle ranges for each unitId and subUnitId, IRangeThemeStyleRule id
+     */
+    private _zebraCrossingCacheMap;
+    private _rowVisibleFuncSet;
+    private _rangeThemeMapChanged$;
+    rangeThemeMapChange$: import("rxjs").Observable<{
+        type: "add" | "remove";
+        styleName: string;
+    }>;
+    constructor(_sheetInterceptorService: SheetInterceptorService, _resourceManagerService: IResourceManagerService, _univerInstanceService: IUniverInstanceService);
+    private _initDefaultTheme;
+    private _ensureRangeThemeStyleMap;
+    private _ensureRangeThemeStyleRuleMap;
+    private _ensureRTreeCollection;
+    getDefaultRangeThemeStyle(name: string): RangeThemeStyle;
+    getCustomRangeThemeStyle(unitId: string, name: string): RangeThemeStyle | undefined;
+    private _getSheetRowVisibleFuncSet;
+    private _getSheetRowVisibleHasInit;
+    refreshSheetRowVisibleFuncSet(unitId: string, subUnitId: string): void;
+    private _ensureZebraCrossingCache;
+    /**
+     * Register range theme styles
+     * @param {string} themeName
+     * @param {IRangeThemeRangeInfo} rangeInfo
+     */
+    registerRangeThemeRule(themeName: string, rangeInfo: IRangeThemeRangeInfo): void;
+    getRegisteredRangeThemeStyle(rangeInfo: IRangeThemeRangeInfo): string | undefined;
+    refreshZebraCrossingCacheBySheet(unitId: string, subUnitId: string): void;
+    removeRangeThemeRule(themeName: string, rangeInfo: IRangeThemeRangeInfo): void;
+    registerDefaultRangeTheme(rangeThemeStyle: RangeThemeStyle): void;
+    unRegisterDefaultRangeTheme(themeName: string): void;
+    getRegisteredRangeThemes(): string[];
+    /**
+     * Register custom range theme style.
+     * @param {string} unitId The unit id.
+     * @param {RangeThemeStyle} rangeThemeStyle The range theme style.
+     */
+    registerRangeThemeStyle(unitId: string, rangeThemeStyle: RangeThemeStyle): void;
+    /**
+     *  Unregister custom range theme style.
+     * @param {string} unitId The unit id.
+     * @param {string} name The name of the range theme style.
+     */
+    unregisterRangeThemeStyle(unitId: string, name: string): void;
+    /**
+     * Gets all custom register themes
+     * @param {string} unitId Which unit to register the range theme style.
+     * @return {string[]} The array of all custom registered themes.
+     */
+    getALLRegisteredTheme(unitId: string): string[];
+    getRangeThemeStyle(unitId: string, name: string): RangeThemeStyle;
+    getCellStyle(unitId: string, subUnitId: string, row: number, col: number): Nullable<IRangeThemeStyleItem>;
+    private _registerIntercept;
+    toJson(unitId: string): string;
+    fromJSON(unitId: string, json: ISheetRangeThemeModelJSON): void;
+    deleteUnitId(unitId: string): void;
+    private _initSnapshot;
+    dispose(): void;
+}
+export {};