@univerjs/sheets 0.12.3 → 0.12.4

package/lib/types/commands/commands/util.d.ts

@@ -4,3 +4,4 @@ export declare function getSuitableRangesInView(ranges: IRange[], skeleton: Null
     suitableRanges: IRange[];
     remainingRanges: IRange[];
 };
+export declare function countCells(cellMatrix: ObjectMatrix<unknown>): number;

package/lib/types/commands/mutations/copy-worksheet-end.mutation.d.ts

@@ -0,0 +1,10 @@
+import { IMutation } from '@univerjs/core';
+export interface ICopyWorksheetEndMutationParams {
+    unitId: string;
+    subUnitId: string;
+}
+/**
+ * This mutation is used to mark the end of a copy worksheet operation that was split into chunks.
+ * When this mutation is applied on the server, it should trigger a snapshot save.
+ */
+export declare const CopyWorksheetEndMutation: IMutation<ICopyWorksheetEndMutationParams, boolean>;

package/lib/types/controllers/config.schema.d.ts

@@ -1,6 +1,21 @@
 import { DependencyOverride } from '@univerjs/core';
 export declare const SHEETS_PLUGIN_CONFIG_KEY = "sheets.config";
 export declare const configSymbol: unique symbol;
+export interface ILargeSheetOperationConfig {
+    /**
+     * The minimum number of cells that defines a "large sheet".
+     * When a sheet has more cells than this threshold:
+     * - Copy sheet: the mutation will be split into multiple batches
+     * - Remove sheet: undo/redo will not be supported
+     * @default 6000
+     */
+    largeSheetCellCountThreshold?: number;
+    /**
+     * The maximum number of cells per batch when splitting mutations for large sheets.
+     * @default 3000
+     */
+    batchSize?: number;
+}
 export interface IUniverSheetsConfig {
     notExecuteFormula?: boolean;
     override?: DependencyOverride;
@@ -22,5 +37,13 @@ export interface IUniverSheetsConfig {
      * @default true
      */
     freezeSync?: boolean;
+    /**
+     * Configuration for large sheet operations.
+     * When a sheet has more cells than the threshold:
+     * - Copy sheet: the mutation will be split into multiple batches
+     * - Remove sheet: undo/redo will not be supported
+     */
+    largeSheetOperation?: ILargeSheetOperationConfig;
 }
+export declare const defaultLargeSheetOperationConfig: Required<ILargeSheetOperationConfig>;
 export declare const defaultPluginConfig: IUniverSheetsConfig;

package/lib/types/index.d.ts

@@ -89,6 +89,7 @@ export { type IToggleCellCheckboxCommandParams, ToggleCellCheckboxCommand } from
 export { type IToggleGridlinesCommandParams, ToggleGridlinesCommand } from './commands/commands/toggle-gridlines.command';
 export { UnregisterWorksheetRangeThemeStyleCommand } from './commands/commands/unregister-range-theme.command';
 export type { IUnregisterWorksheetRangeThemeStyleCommandParams } from './commands/commands/unregister-range-theme.command';
+export { countCells } from './commands/commands/util';
 export { alignToMergedCellsBorders, getCellAtRowCol, isSingleCellSelection, setEndForRange } from './commands/commands/utils/selection-utils';
 export { followSelectionOperation, getPrimaryForRange } from './commands/commands/utils/selection-utils';
 export { copyRangeStyles } from './commands/commands/utils/selection-utils';
@@ -99,6 +100,7 @@ export type { IAddRangeThemeMutationParams } from './commands/mutations/add-rang
 export { AddMergeUndoMutationFactory, AddWorksheetMergeMutation } from './commands/mutations/add-worksheet-merge.mutation';
 export { AddWorksheetProtectionMutation, type IAddWorksheetProtectionParams } from './commands/mutations/add-worksheet-protection.mutation';
 export { SetWorksheetRangeThemeStyleMutation, SetWorksheetRangeThemeStyleMutationFactory } from './commands/mutations/add-worksheet-range-theme.mutation';
+export { CopyWorksheetEndMutation, type ICopyWorksheetEndMutationParams } from './commands/mutations/copy-worksheet-end.mutation';
 export { DeleteRangeProtectionMutation, FactoryDeleteRangeProtectionMutation, type IDeleteRangeProtectionMutationParams } from './commands/mutations/delete-range-protection.mutation';
 export { DeleteWorksheetProtectionMutation } from './commands/mutations/delete-worksheet-protection.mutation';
 export type { IDeleteWorksheetProtectionParams } from './commands/mutations/delete-worksheet-protection.mutation';
@@ -153,7 +155,7 @@ export { getInsertRangeMutations, getRemoveRangeMutations } from './commands/uti
 export { handleInsertRangeMutation } from './commands/utils/handle-range-mutation';
 export { type ISheetCommandSharedParams } from './commands/utils/interface';
 export { getSelectionsService } from './commands/utils/selection-command-util';
-export { type IUniverSheetsConfig } from './controllers/config.schema';
+export { defaultLargeSheetOperationConfig, type ILargeSheetOperationConfig, type IUniverSheetsConfig, SHEETS_PLUGIN_CONFIG_KEY } from './controllers/config.schema';
 export { MAX_CELL_PER_SHEET_KEY } from './controllers/config/config';
 export { DefinedNameDataController } from './controllers/defined-name-data.controller';
 export { SCOPE_WORKBOOK_VALUE_DEFINED_NAME } from './controllers/defined-name-data.controller';
@@ -173,6 +175,7 @@ export type { IRangeThemeStyleItem } from './model/range-theme-util';
 export { UniverSheetsPlugin } from './plugin';
 export { BorderStyleManagerService, type IBorderInfo } from './services/border-style-manager.service';
 export { ExclusiveRangeService, IExclusiveRangeService } from './services/exclusive-range/exclusive-range-service';
+export { SheetLazyExecuteScheduleService } from './services/lazy-execute-schedule.service';
 export { NumfmtService } from './services/numfmt/numfmt.service';
 export type { INumfmtItem, INumfmtItemWithCache } from './services/numfmt/type';
 export { INumfmtService } from './services/numfmt/type';

package/lib/types/services/lazy-execute-schedule.service.d.ts

@@ -0,0 +1,47 @@
+import { IMutationInfo, Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
+import { ISetRangeValuesMutationParams } from '../commands/mutations/set-range-values.mutation';
+/**
+ * Service to schedule and execute remaining SetRangeValuesMutation tasks
+ * during browser idle time after a sheet copy operation.
+ *
+ * This improves user experience by:
+ * 1. Immediately showing the copied sheet with first chunk of data
+ * 2. Filling remaining data in background during idle time
+ * 3. Automatically canceling tasks if the sheet is deleted
+ * 4. Warning user if they try to close while tasks are pending
+ */
+export declare class SheetLazyExecuteScheduleService extends Disposable {
+    private readonly _commandService;
+    private readonly _univerInstanceService;
+    private _tasks;
+    private _idleCallbackId;
+    private _beforeUnloadHandler;
+    constructor(_commandService: ICommandService, _univerInstanceService: IUniverInstanceService);
+    /**
+     * Check if there are any pending tasks
+     */
+    hasPendingTasks(): boolean;
+    /**
+     * Get the count of pending mutations across all tasks
+     */
+    getPendingMutationsCount(): number;
+    /**
+     * Schedule mutations to be executed during idle time
+     * @param unitId - The workbook unit ID
+     * @param subUnitId - The sheet ID (newly created sheet)
+     * @param mutations - Remaining SetRangeValuesMutation to execute
+     */
+    scheduleMutations(unitId: string, subUnitId: string, mutations: IMutationInfo<ISetRangeValuesMutationParams>[]): void;
+    /**
+     * Cancel scheduled mutations for a specific sheet
+     * Called when the sheet is deleted
+     */
+    cancelScheduledMutations(unitId: string, subUnitId: string): void;
+    private _cancelTask;
+    private _cancelAllTasks;
+    private _scheduleNextIdle;
+    private _processIdleTasks;
+    private _isSheetExist;
+    private _setupBeforeUnloadListener;
+    private _removeBeforeUnloadListener;
+}