@univerjs/sheets 0.2.5 → 0.2.7

package/lib/types/controllers/merge-cell.controller.d.ts

@@ -1,4 +1,4 @@
-import { IRange, Dimension, Disposable, DisposableCollection, ICommandService, Injector, IUniverInstanceService } from '@univerjs/core';
+import { IRange, Dimension, Disposable, DisposableCollection, ICommandService, Injector, InterceptorManager, IUniverInstanceService } from '@univerjs/core';
 import { IRemoveWorksheetMergeMutationParams } from '../basics/interfaces/mutation-interface';
 import { RefRangeService } from '../services/ref-range/ref-range.service';
 import { EffectRefRangeParams } from '../services/ref-range/type';
@@ -12,6 +12,7 @@ import { SheetInterceptorService } from '../services/sheet-interceptor/sheet-int
  * @return {*}
  */
 export declare function getAddMergeMutationRangeByType(selection: IRange[], type?: Dimension): IRange[];
+export declare const MERGE_CELL_INTERCEPTOR_CHECK: import('@univerjs/core').IInterceptor<boolean, IRange[]>;
 export declare class MergeCellController extends Disposable {
     private readonly _commandService;
     private readonly _refRangeService;
@@ -20,6 +21,9 @@ export declare class MergeCellController extends Disposable {
     private _sheetInterceptorService;
     private _selectionManagerService;
     disposableCollection: DisposableCollection;
+    readonly interceptor: InterceptorManager<{
+        MERGE_CELL_INTERCEPTOR_CHECK: import('@univerjs/core').IInterceptor<boolean, IRange[]>;
+    }>;
     constructor(_commandService: ICommandService, _refRangeService: RefRangeService, _univerInstanceService: IUniverInstanceService, _injector: Injector, _sheetInterceptorService: SheetInterceptorService, _selectionManagerService: SheetsSelectionsService);
     private _initCommandInterceptor;
     refRangeHandle(config: EffectRefRangeParams, unitId: string, subUnitId: string): {

package/lib/types/index.d.ts

@@ -45,7 +45,7 @@ export { handleBaseInsertRange, handleBaseMoveRowsCols, handleBaseRemoveRange, h
 export { INTERCEPTOR_POINT } from './services/sheet-interceptor/interceptor-const';
 export { SheetInterceptorService } from './services/sheet-interceptor/sheet-interceptor.service';
 export type { ISheetLocation, ISheetLocationBase, ISheetRowLocation } from './services/sheet-interceptor/utils/interceptor';
-export { MergeCellController } from './controllers/merge-cell.controller';
+export { MergeCellController, MERGE_CELL_INTERCEPTOR_CHECK } from './controllers/merge-cell.controller';
 export { AddMergeRedoSelectionsOperationFactory, AddMergeUndoSelectionsOperationFactory } from './commands/utils/handle-merge-operation';
 export type { FormatType } from './services/numfmt/type';
 export { expandToContinuousRange } from './basics/utils';
@@ -54,6 +54,7 @@ export type { IWorksheetProtectionRule } from './services/permission/type';
 export { WorksheetProtectionRuleModel, WorksheetProtectionPointModel } from './services/permission/worksheet-permission';
 export { getAllWorkbookPermissionPoint, defaultWorkbookPermissionPoints } from './services/permission/workbook-permission';
 export { WorksheetCopyPermission, WorksheetSelectProtectedCellsPermission, WorksheetSelectUnProtectedCellsPermission, WorksheetSetCellStylePermission, WorksheetSetCellValuePermission, WorksheetViewPermission, WorksheetSetRowStylePermission, WorksheetSetColumnStylePermission, WorksheetInsertRowPermission, WorksheetInsertColumnPermission, WorksheetInsertHyperlinkPermission, WorksheetDeleteRowPermission, WorksheetDeleteColumnPermission, WorksheetSortPermission, WorksheetFilterPermission, WorksheetPivotTablePermission, WorksheetEditExtraObjectPermission, WorksheetManageCollaboratorPermission, WorksheetEditPermission, WorkbookCommentPermission, WorkbookEditablePermission, WorkbookDuplicatePermission, WorkbookPrintPermission, WorkbookExportPermission, WorkbookMoveSheetPermission, WorkbookDeleteSheetPermission, WorkbookHideSheetPermission, WorkbookRenameSheetPermission, WorkbookCreateSheetPermission, WorkbookHistoryPermission, WorkbookViewPermission, WorkbookSharePermission, WorkbookCopyPermission, WorkbookManageCollaboratorPermission, WorkbookViewHistoryPermission, WorkbookRecoverHistoryPermission, } from './services/permission/permission-point';
+export { checkRangesEditablePermission } from './services/permission/util';
 export { RangeProtectionRenderModel, type ICellPermission } from './model/range-protection-render.model';
 export { RangeProtectionRuleModel, type IObjectModel, type IRangeProtectionRule, type IModel } from './model/range-protection-rule.model';
 export type { IWorksheetProtectionRenderCellData } from './services/permission/worksheet-permission/type';
@@ -62,7 +63,7 @@ export { RangeProtectionService } from './services/permission/range-permission/r
 export { type IRangePermissionPoint, getAllRangePermissionPoint, getDefaultRangePermission, } from './services/permission/range-permission/util';
 export { RangeProtectionPermissionEditPoint } from './services/permission/permission-point/range/edit';
 export { RangeProtectionPermissionViewPoint } from './services/permission/permission-point/range/view';
-export { generateNullCellValue } from './basics/utils';
+export { generateNullCellValue, generateNullCell } from './basics/utils';
 export { AddRangeProtectionCommand, type IAddRangeProtectionCommandParams } from './commands/commands/add-range-protection.command';
 export { AddWorksheetMergeCommand, AddWorksheetMergeAllCommand, AddWorksheetMergeVerticalCommand, AddWorksheetMergeHorizontalCommand, } from './commands/commands/add-worksheet-merge.command';
 export { ClearSelectionAllCommand } from './commands/commands/clear-selection-all.command';

package/lib/types/services/permission/util.d.ts

@@ -0,0 +1,3 @@
+import { IAccessor, IRange } from '@univerjs/core';
+
+export declare const checkRangesEditablePermission: (accessor: IAccessor, unitId: string, subUnitId: string, ranges: IRange[]) => boolean;

package/lib/types/services/selections/selection-manager.service.d.ts

@@ -60,6 +60,12 @@ export declare class WorkbookSelections extends Disposable {
     /** Clear all selections in this workbook. */
     clear(): void;
     addSelections(sheetId: string, selectionDatas: ISelectionWithStyle[]): void;
+    /**
+     *
+     * @param sheetId
+     * @param selectionDatas
+     * @param type
+     */
     setSelections(sheetId: string, selectionDatas: ISelectionWithStyle[], type?: SelectionMoveType): void;
     getCurrentSelections(): Readonly<ISelectionWithStyle[]>;
     getSelectionOfWorksheet(sheetId: string): ISelectionWithStyle[];
@@ -68,6 +74,11 @@ export declare class WorkbookSelections extends Disposable {
         primary: ISelectionCell;
     }>>;
     private _worksheetSelections;
+    /**
+     * same as _getCurrentSelections, but would set [] if no selection.
+     * @param sheetId
+     * @returns this._worksheetSelections
+     */
     private _ensureSheetSelection;
     private _emitOnEnd;
 }

package/lib/types/services/sheet-interceptor/sheet-interceptor.service.d.ts

@@ -1,9 +1,22 @@
-import { ICommandInfo, IDisposable, IInterceptor, IUndoRedoCommandInfosByInterceptor, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { ICommandInfo, IDisposable, IInterceptor, IRange, IUndoRedoCommandInfosByInterceptor, Disposable, IUniverInstanceService } from '@univerjs/core';
 
+export interface IBeforeCommandInterceptor {
+    priority?: number;
+    performCheck(info: ICommandInfo): Promise<boolean>;
+}
 export interface ICommandInterceptor {
     priority?: number;
     getMutations(command: ICommandInfo): IUndoRedoCommandInfosByInterceptor;
 }
+export interface IRangesInfo {
+    unitId: string;
+    subUnitId: string;
+    ranges: IRange[];
+}
+export interface IRangeInterceptors {
+    priority?: number;
+    getMutations(rangesInfo: IRangesInfo): IUndoRedoCommandInfosByInterceptor;
+}
 /**
  * This class expose methods for sheet features to inject code to sheet underlying logic.
  *
@@ -13,17 +26,33 @@ export declare class SheetInterceptorService extends Disposable {
     private readonly _univerInstanceService;
     private _interceptorsByName;
     private _commandInterceptors;
+    private _rangeInterceptors;
+    private _beforeCommandInterceptor;
     private readonly _workbookDisposables;
     private readonly _worksheetDisposables;
     constructor(_univerInstanceService: IUniverInstanceService);
     dispose(): void;
     interceptCommand(interceptor: ICommandInterceptor): IDisposable;
+    interceptBeforeCommand(interceptor: IBeforeCommandInterceptor): IDisposable;
+    /**
+     * before command execute, call this method to get the flag of whether it can be executed the command，
+     * @param info ICommandInfo
+     * @returns Promise<boolean>
+     */
+    beforeCommandExecute(info: ICommandInfo): Promise<boolean>;
+    /**
+     * By adding callbacks to some Ranges can get some additional mutations, such as clearing all plugin data in a certain area.
+     * @param interceptor IRangeInterceptors
+     * @returns IDisposable
+     */
+    interceptRanges(interceptor: IRangeInterceptors): IDisposable;
     /**
      * When command is executing, call this method to gether undo redo mutations from upper features.
      * @param command
      * @returns
      */
-    onCommandExecute(command: ICommandInfo): IUndoRedoCommandInfosByInterceptor;
+    onCommandExecute(info: ICommandInfo): IUndoRedoCommandInfosByInterceptor;
+    generateMutationsByRanges(info: IRangesInfo): IUndoRedoCommandInfosByInterceptor;
     intercept<T extends IInterceptor<any, any>>(name: T, interceptor: T): IDisposable;
     fetchThroughInterceptors<T, C>(name: IInterceptor<T, C>): (initValue: import('@univerjs/core/common/type-util.js').Nullable<T>, initContext: C) => import('@univerjs/core/common/type-util.js').Nullable<T>;
     private _interceptWorkbook;