@univerjs/sheets 0.1.0-beta.2 → 0.1.0-beta.3

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { Dimension, ICellData, IColumnData, IObjectArrayPrimitiveType, IObjectMatrixPrimitiveType, IRange, IRowData, IWorksheetData } from '@univerjs/core';
+import type { Dimension, ICellData, IColumnData, IObjectArrayPrimitiveType, IObjectMatrixPrimitiveType, IRange, IRowData, IWorksheetData, Nullable } from '@univerjs/core';
 /** Params of `RemoveSheetMutation` */
 export interface IRemoveSheetMutationParams {
     subUnitId: string;
@@ -64,7 +64,7 @@ export interface IInsertRangeMutationParams {
     subUnitId: string;
     range: IRange;
     shiftDimension: Dimension;
-    cellValue?: IObjectMatrixPrimitiveType<ICellData>;
+    cellValue?: IObjectMatrixPrimitiveType<Nullable<ICellData>>;
 }
 /** Params of RemoveWorksheetMergeMutation */
 export interface IRemoveWorksheetMergeMutationParams {

package/lib/types/commands/commands/move-range.command.d.ts

@@ -13,10 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ICommand, IRange } from '@univerjs/core';
+import type { ICommand, IMutationInfo, IRange } from '@univerjs/core';
+import type { IAccessor } from '@wendellhu/redi';
 export interface IMoveRangeCommandParams {
     toRange: IRange;
     fromRange: IRange;
 }
 export declare const MoveRangeCommandId = "sheet.command.move-range";
 export declare const MoveRangeCommand: ICommand;
+export interface IRangeUnit {
+    unitId: string;
+    subUnitId: string;
+    range: IRange;
+}
+export declare function getMoveRangeUndoRedoMutations(accessor: IAccessor, from: IRangeUnit, to: IRangeUnit, ignoreMerge?: boolean): {
+    redos: IMutationInfo<object>[];
+    undos: IMutationInfo<object>[];
+} | null;

package/lib/types/commands/commands/utils/selection-utils.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IRange, ISelectionCell, Worksheet } from '@univerjs/core';
+import type { IRange, ISelectionCell, Workbook, Worksheet } from '@univerjs/core';
 export interface IExpandParams {
     left?: boolean;
     right?: boolean;
@@ -40,3 +40,15 @@ export interface IInterval {
  * @returns
  */
 export declare function calculateTotalLength(intervalsObject: IInterval): number;
+export declare const followSelectionOperation: (range: IRange, workbook: Workbook, worksheet: Worksheet) => {
+    id: string;
+    params: {
+        unitId: string;
+        sheetId: string;
+        pluginName: string;
+        selections: {
+            range: IRange;
+            primary: ISelectionCell;
+        }[];
+    };
+};

package/lib/types/commands/mutations/empty.mutation.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+import type { IMutation } from '@univerjs/core';
+export declare const EmptyMutation: IMutation<{}, boolean>;

package/lib/types/commands/mutations/set-worksheet-row-height.mutation.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IMutation, IObjectArrayPrimitiveType, IRange, Nullable } from '@univerjs/core';
+import type { BooleanNumber, IMutation, IObjectArrayPrimitiveType, IRange, Nullable } from '@univerjs/core';
 import type { IRowAutoHeightInfo } from '@univerjs/engine-render';
 import type { IAccessor } from '@wendellhu/redi';
 export interface ISetWorksheetRowHeightMutationParams {
@@ -26,7 +26,7 @@ export interface ISetWorksheetRowIsAutoHeightMutationParams {
     unitId: string;
     subUnitId: string;
     ranges: IRange[];
-    autoHeightInfo: boolean | IObjectArrayPrimitiveType<Nullable<boolean>>;
+    autoHeightInfo: BooleanNumber | IObjectArrayPrimitiveType<Nullable<BooleanNumber>>;
 }
 export interface ISetWorksheetRowAutoHeightMutationParams {
     unitId: string;

package/lib/types/commands/{mutations/delete-range.mutation.d.ts → utils/handle-range-mutation.d.ts}

@@ -13,10 +13,33 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IMutation, IRange, Nullable } from '@univerjs/core';
+import type { ICellData, IMutationInfo, IObjectMatrixPrimitiveType, IRange, Nullable } from '@univerjs/core';
 import { Dimension, ObjectMatrix } from '@univerjs/core';
 import type { IAccessor } from '@wendellhu/redi';
 import type { IDeleteRangeMutationParams, IInsertRangeMutationParams } from '../../basics/interfaces/mutation-interface';
+/**
+ * Generate undo mutation of a `InsertRangeMutation`
+ *
+ * @param {IAccessor} accessor - injector accessor
+ * @param {IInsertRangeMutationParams} params - do mutation params
+ * @returns {IDeleteRangeMutationParams} undo mutation params
+ */
+export declare const InsertRangeUndoMutationFactory: (accessor: IAccessor, params: IInsertRangeMutationParams) => IDeleteRangeMutationParams;
+/**
+ * InsertRange is not a mutation but combination of `SetRangeValuesMutation` and `MoveRangeMutation`.
+ * @param accessor
+ * @param params
+ * @returns
+ */
+export declare function getInsertRangeMutations(accessor: IAccessor, params: IInsertRangeMutationParams): {
+    redo: IMutationInfo<object>[];
+    undo: IMutationInfo<object>[];
+};
+export declare function getRemoveRangeMutations(accessor: IAccessor, params: IDeleteRangeMutationParams): {
+    redo: IMutationInfo<object>[];
+    undo: IMutationInfo<object>[];
+};
+export declare function handleInsertRangeMutation<T>(cellMatrix: ObjectMatrix<T>, range: IRange, lastEndRow: number, lastEndColumn: number, shiftDimension: Dimension, cellValue?: IObjectMatrixPrimitiveType<T>): void;
 /**
  * Generate undo mutation of a `DeleteRangeMutation`
  *
@@ -25,5 +48,5 @@ import type { IDeleteRangeMutationParams, IInsertRangeMutationParams } from '../
  * @returns {IInsertRangeMutationParams} undo mutation params
  */
 export declare const DeleteRangeUndoMutationFactory: (accessor: IAccessor, params: IDeleteRangeMutationParams) => Nullable<IInsertRangeMutationParams>;
-export declare const DeleteRangeMutation: IMutation<IDeleteRangeMutationParams, boolean>;
 export declare function handleDeleteRangeMutation<T>(cellMatrix: ObjectMatrix<T>, range: IRange, lastEndRow: number, lastEndColumn: number, shiftDimension: Dimension): void;
+export declare function generateNullCellValue(range: IRange[]): IObjectMatrixPrimitiveType<Nullable<ICellData>>;

package/lib/types/index.d.ts

@@ -61,12 +61,9 @@ export { type ISetWorksheetNameCommandParams, SetWorksheetNameCommand, } from '.
 export { SetWorksheetOrderCommand } from './commands/commands/set-worksheet-order.command';
 export { DeltaRowHeightCommand, type IDeltaRowHeightCommand, type ISetWorksheetRowIsAutoHeightCommandParams, SetRowHeightCommand, SetWorksheetRowIsAutoHeightCommand, } from './commands/commands/set-worksheet-row-height.command';
 export { SetWorksheetShowCommand } from './commands/commands/set-worksheet-show.command';
-export { getPrimaryForRange } from './commands/commands/utils/selection-utils';
+export { followSelectionOperation, getPrimaryForRange } from './commands/commands/utils/selection-utils';
 export { AddMergeUndoMutationFactory, AddWorksheetMergeMutation, } from './commands/mutations/add-worksheet-merge.mutation';
-export { DeleteRangeMutation } from './commands/mutations/delete-range.mutation';
-export { handleDeleteRangeMutation } from './commands/mutations/delete-range.mutation';
-export { InsertRangeMutation } from './commands/mutations/insert-range.mutation';
-export { handleInsertRangeMutation } from './commands/mutations/insert-range.mutation';
+export { EmptyMutation } from './commands/mutations/empty.mutation';
 export { InsertColMutation, InsertColMutationUndoFactory, InsertRowMutation, InsertRowMutationUndoFactory, } from './commands/mutations/insert-row-col.mutation';
 export { InsertSheetMutation, InsertSheetUndoMutationFactory } from './commands/mutations/insert-sheet.mutation';
 export { MoveRangeMutation } from './commands/mutations/move-range.mutation';
@@ -99,15 +96,19 @@ export { type ISetWorksheetRowAutoHeightMutationParams, type ISetWorksheetRowHei
 export { type ISetSelectionsOperationParams, SetSelectionsOperation } from './commands/operations/selection.operation';
 export { SetWorksheetActiveOperation } from './commands/operations/set-worksheet-active.operation';
 export { type ISetWorksheetActiveOperationParams } from './commands/operations/set-worksheet-active.operation';
+export { handleDeleteRangeMutation } from './commands/utils/handle-range-mutation';
+export { getInsertRangeMutations, getRemoveRangeMutations } from './commands/utils/handle-range-mutation';
+export { handleInsertRangeMutation } from './commands/utils/handle-range-mutation';
 export { type ISheetCommandSharedParams } from './commands/utils/interface';
 export { getAddMergeMutationRangeByType } from './controllers/merge-cell.controller';
 export { enUS, zhCN } from './locale';
+export { NumfmtService } from './services/numfmt/numfmt.service';
 export type { FormatType, INumfmtItem, INumfmtItemWithCache } from './services/numfmt/type';
 export { INumfmtService } from './services/numfmt/type';
 export { RefRangeService } from './services/ref-range/ref-range.service';
 export type { EffectRefRangeParams, IOperator } from './services/ref-range/type';
 export { EffectRefRangId, OperatorType } from './services/ref-range/type';
-export { handleDeleteRangeMoveLeft, handleDeleteRangeMoveUp, handleInsertCol, handleInsertRangeMoveDown, handleInsertRangeMoveRight, handleInsertRow, handleIRemoveCol, handleIRemoveRow, handleMoveCols, handleMoveRange, handleMoveRows, runRefRangeMutations, } from './services/ref-range/util';
+export { handleBaseInsertRange, handleBaseMoveRowsCols, handleBaseRemoveRange, handleDeleteRangeMoveLeft, handleDeleteRangeMoveUp, handleInsertCol, handleInsertRangeMoveDown, handleInsertRangeMoveRight, handleInsertRow, handleIRemoveCol, handleIRemoveRow, handleMoveCols, handleMoveRange, handleMoveRows, rotateRange, runRefRangeMutations, } from './services/ref-range/util';
 export { INTERCEPTOR_POINT } from './services/sheet-interceptor/interceptor-const';
 export { SheetInterceptorService } from './services/sheet-interceptor/sheet-interceptor.service';
 export type { ISheetLocation } from './services/sheet-interceptor/utils/interceptor';

package/lib/types/services/ref-range/util.d.ts

@@ -14,22 +14,37 @@
  * limitations under the License.
  */
 import type { IRange } from '@univerjs/core';
-import type { IDeleteOperator, IDeleteRangeMoveLeftCommand, IDeleteRangeMoveUpCommand, IHorizontalMoveOperator, IInsertColCommand, IInsertRangeMoveDownCommand, IInsertRangeMoveRightCommand, IInsertRowCommand, IMoveColsCommand, IMoveRangeCommand, IMoveRowsCommand, IOperator, IRemoveRowColCommand, IVerticalMoveOperator } from './type';
+import type { IDeleteRangeMoveLeftCommand, IDeleteRangeMoveUpCommand, IInsertColCommand, IInsertRangeMoveDownCommand, IInsertRangeMoveRightCommand, IInsertRowCommand, IMoveColsCommand, IMoveRangeCommand, IMoveRowsCommand, IOperator, IRemoveRowColCommand } from './type';
+export declare const rotateRange: (range: IRange) => IRange;
+interface ILine {
+    start: number;
+    end: number;
+}
+/**
+ * see docs/tldr/ref-range/move-rows-cols.tldr
+ */
+export declare const handleBaseMoveRowsCols: (fromRange: ILine, toRange: ILine, effectRange: ILine) => {
+    length: number;
+    step: number;
+};
 export declare const handleMoveRows: (params: IMoveRowsCommand, targetRange: IRange) => IOperator[];
 export declare const handleMoveCols: (params: IMoveColsCommand, targetRange: IRange) => IOperator[];
 export declare const handleMoveRange: (param: IMoveRangeCommand, targetRange: IRange) => IOperator[];
-/**
- * see the doc 【ref-range-remove-col.tldr】
- */
+export declare const handleBaseRemoveRange: (removeRange: IRange, targetRange: IRange) => {
+    step: number;
+    length: number;
+} | null;
 export declare const handleIRemoveCol: (param: IRemoveRowColCommand, targetRange: IRange) => IOperator[];
-/**
- * see the doc 【ref-range-remove-row.tldr】
- */
 export declare const handleIRemoveRow: (param: IRemoveRowColCommand, targetRange: IRange) => IOperator[];
-export declare const handleInsertRow: (param: IInsertRowCommand, targetRange: IRange) => IDeleteOperator[] | IVerticalMoveOperator[];
-export declare const handleInsertCol: (param: IInsertColCommand, targetRange: IRange) => IDeleteOperator[] | IHorizontalMoveOperator[];
-export declare const handleInsertRangeMoveDown: (param: IInsertRangeMoveDownCommand, targetRange: IRange) => IDeleteOperator[] | IVerticalMoveOperator[];
-export declare const handleInsertRangeMoveRight: (param: IInsertRangeMoveRightCommand, targetRange: IRange) => IDeleteOperator[] | IHorizontalMoveOperator[];
-export declare const handleDeleteRangeMoveLeft: (param: IDeleteRangeMoveLeftCommand, targetRange: IRange) => IDeleteOperator[] | IHorizontalMoveOperator[];
-export declare const handleDeleteRangeMoveUp: (param: IDeleteRangeMoveUpCommand, targetRange: IRange) => IDeleteOperator[] | IVerticalMoveOperator[];
+export declare const handleBaseInsertRange: (insertRange: IRange, targetRange: IRange) => {
+    step: number;
+    length: number;
+};
+export declare const handleInsertRow: (param: IInsertRowCommand, targetRange: IRange) => IOperator[];
+export declare const handleInsertCol: (param: IInsertColCommand, targetRange: IRange) => IOperator[];
+export declare const handleInsertRangeMoveDown: (param: IInsertRangeMoveDownCommand, targetRange: IRange) => IOperator[];
+export declare const handleInsertRangeMoveRight: (param: IInsertRangeMoveRightCommand, targetRange: IRange) => IOperator[];
+export declare const handleDeleteRangeMoveLeft: (param: IDeleteRangeMoveLeftCommand, targetRange: IRange) => IOperator[];
+export declare const handleDeleteRangeMoveUp: (param: IDeleteRangeMoveUpCommand, targetRange: IRange) => IOperator[];
 export declare const runRefRangeMutations: (operators: IOperator[], range: IRange) => IRange | null;
+export {};