@univerjs/sheets 0.2.1 → 0.2.3

package/lib/locale/vi-VN.json

@@ -0,0 +1,14 @@
+{
+  "sheets": {
+    "tabs": {
+      "sheetCopy": "（Bản sao {0}）",
+      "sheet": "Bảng tính"
+    },
+    "info": {
+      "overlappingSelections": "Không thể sử dụng lệnh này trên các vùng chọn chồng chéo nhau",
+      "acrossMergedCell": "Không thể vượt qua các ô đã hợp nhất",
+      "partOfCell": "Chỉ chọn một phần của ô đã hợp nhất",
+      "hideSheet": "Không có bảng tính nào hiển thị sau khi ẩn"
+    }
+  }
+}

package/lib/locale/zh-TW.json

@@ -0,0 +1,14 @@
+{
+  "sheets": {
+    "tabs": {
+      "sheetCopy": "（副本{0}）",
+      "sheet": "工作表"
+    },
+    "info": {
+      "overlappingSelections": "無法對重疊選區使用該命令",
+      "acrossMergedCell": "無法跨越合併儲存格",
+      "partOfCell": "僅選擇了合併儲存格的一部份",
+      "hideSheet": "隱藏後無可見工作表"
+    }
+  }
+}

package/lib/types/basics/__tests__/cell-value.spec.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/basics/cell-style.d.ts

@@ -0,0 +1,8 @@
+import { ICellData, IStyleData, Nullable, Styles } from '@univerjs/core';
+
+export declare function handleStyle(styles: Styles, oldVal: ICellData, newVal: ICellData): void;
+/**
+ * Convert old style data for storage
+ * @param style
+ */
+export declare function transformStyle(oldStyle: Nullable<IStyleData>, newStyle: Nullable<IStyleData>): Nullable<IStyleData>;

package/lib/types/basics/cell-type.d.ts

@@ -0,0 +1,19 @@
+import { CellValue, ICellData, Nullable, Styles, CellValueType } from '@univerjs/core';
+
+/**
+ * Get cell value type by style, new value and old value.
+ * If the new value contains t, then take t directly. In other cases, we need to dynamically determine based on actual data and styles
+ * @param newVal
+ * @param oldVal
+ * @returns
+ */
+export declare function getCellType(styles: Styles, newVal: ICellData, oldVal: ICellData): void | CellValueType | null;
+/**
+ * Get the correct type after setting values to a cell.
+ *
+ * @param v the new value
+ * @param type the old type
+ * @returns the new type
+ */
+export declare function checkCellValueType(v: Nullable<CellValue>, type: Nullable<CellValueType>): Nullable<CellValueType>;
+export declare function getCellTypeByPattern(cell: ICellData, pattern: string): Nullable<CellValueType>;

package/lib/types/basics/cell-value.d.ts

@@ -0,0 +1,22 @@
+import { ICellData, Nullable, CellValueType } from '@univerjs/core';
+
+/**
+ * Get cell value from new value by type
+ * @param type
+ * @param cell
+ * @returns
+ */
+export declare function getCellValue(type: Nullable<CellValueType>, cell: ICellData): Nullable<import('@univerjs/core').CellValue>;
+/**
+ * Check if the value can be casted to a boolean.
+ * @internal
+ * @param value
+ * @returns It would return null if the value cannot be casted to a boolean, and would return the boolean value if it can be casted.
+ */
+export declare function extractBooleanValue(value: Nullable<string | number | boolean>): Nullable<boolean>;
+/**
+ * Supplement the data of the cell, set the other value to NULL, Used to reset properties when undoing
+ * @param value
+ * @returns
+ */
+export declare function setNull(value: Nullable<ICellData>): ICellData | null;

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

@@ -1,4 +1,4 @@
-import { ICellData, IObjectMatrixPrimitiveType, IRange, Nullable, Worksheet } from '@univerjs/core';
+import { ICellData, IObjectMatrixPrimitiveType, IRange, Nullable, UniverInstanceService, Workbook, Worksheet } from '@univerjs/core';
 import { IExpandParams } from '../commands/commands/utils/selection-utils';
 
 export declare const groupByKey: <T = Record<string, unknown>>(arr: T[], key: string, blankKey?: string) => Record<string, T[]>;
@@ -17,3 +17,4 @@ export declare function generateNullCell(range: IRange[]): IObjectMatrixPrimitiv
  */
 export declare function generateNullCellValue(range: IRange[]): IObjectMatrixPrimitiveType<ICellData>;
 export declare function generateNullCellStyle(ranges: IRange[]): IObjectMatrixPrimitiveType<ICellData>;
+export declare function getActiveWorksheet(instanceService: UniverInstanceService): [Nullable<Workbook>, Nullable<Worksheet>];

package/lib/types/commands/mutations/set-range-values.mutation.d.ts

@@ -1,4 +1,4 @@
-import { CellValue, IBorderData, ICellData, ICopyToOptionsData, IDocumentData, IMutation, IMutationCommonParams, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, CellValueType } from '@univerjs/core';
+import { ICellData, ICopyToOptionsData, IMutation, IMutationCommonParams, IObjectMatrixPrimitiveType, IRange, Nullable } from '@univerjs/core';
 import { IAccessor } from '@wendellhu/redi';
 
 /** Params of `SetRangeValuesMutation` */
@@ -31,49 +31,3 @@ export declare const SetRangeValuesUndoMutationFactory: (accessor: IAccessor, pa
    Intercept 15-digit number reference function truncateNumber
  */
 export declare const SetRangeValuesMutation: IMutation<ISetRangeValuesMutationParams, boolean>;
-/**
- * Get the correct type after setting values to a cell.
- *
- * @param v the new value
- * @param oldType the old type
- * @returns the new type
- */
-export declare function checkCellValueType(v: Nullable<CellValue>, oldType: Nullable<CellValueType>): Nullable<CellValueType>;
-/**
- * Check if the value can be casted to a boolean.
- * @internal
- * @param value
- * @returns It would return null if the value cannot be casted to a boolean, and would return the boolean value if it can be casted.
- */
-export declare function extractBooleanValue(value: Nullable<string | number | boolean>): Nullable<boolean>;
-/**
- * Convert old style data for storage
- * @param style
- */
-export declare function transformStyle(oldStyle: Nullable<IStyleData>, newStyle: Nullable<IStyleData>): Nullable<IStyleData>;
-/**
- * Convert old style normal key for storage
- *
- * @param style
- */
-export declare function transformNormalKey(oldStyle: Nullable<IStyleData>, newStyle: Nullable<IStyleData>): Nullable<IStyleData>;
-/**
- * Convert old style border for storage
- *
-
- * @param style
- */
-export declare function transformBorders(oldBorders: IBorderData, newBorders: Nullable<IBorderData>): IBorderData;
-/**
- * merge new style to old style
- *
- * @param oldStyle
- * @param newStyle
- */
-export declare function mergeStyle(oldStyle: Nullable<IStyleData>, newStyle: Nullable<IStyleData>, isRichText?: boolean): Nullable<IStyleData>;
-/**
- * Find the text style of all paragraphs and modify it to the new style
- * @param p
- * @param newStyle
- */
-export declare function mergeRichTextStyle(p: IDocumentData, newStyle: Nullable<IStyleData>): void;

package/lib/types/commands/operations/selection.operation.d.ts

@@ -1,11 +1,10 @@
 import { IOperation } from '@univerjs/core';
 import { ISelectionWithStyle } from '../../basics/selection';
-import { SelectionMoveType } from '../../services/selection-manager.service';
+import { SelectionMoveType } from '../../services/selections/selection-manager.service';
 
 export interface ISetSelectionsOperationParams {
     unitId: string;
     subUnitId: string;
-    pluginName: string;
     selections: ISelectionWithStyle[];
     type?: SelectionMoveType;
 }

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

@@ -0,0 +1,4 @@
+import { IAccessor } from '@wendellhu/redi';
+import { SheetsSelectionsService } from '../../services/selections/selection-manager.service';
+
+export declare function getSelectionsService(accessor: IAccessor): SheetsSelectionsService;

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

@@ -3,7 +3,7 @@ import { Injector } from '@wendellhu/redi';
 import { IRemoveWorksheetMergeMutationParams } from '../basics/interfaces/mutation-interface';
 import { RefRangeService } from '../services/ref-range/ref-range.service';
 import { EffectRefRangeParams } from '../services/ref-range/type';
-import { SelectionManagerService } from '../services/selection-manager.service';
+import { SheetsSelectionsService } from '../services/selections/selection-manager.service';
 import { SheetInterceptorService } from '../services/sheet-interceptor/sheet-interceptor.service';
 
 /**
@@ -21,7 +21,7 @@ export declare class MergeCellController extends Disposable {
     private _sheetInterceptorService;
     private _selectionManagerService;
     disposableCollection: DisposableCollection;
-    constructor(_commandService: ICommandService, _refRangeService: RefRangeService, _univerInstanceService: IUniverInstanceService, _injector: Injector, _sheetInterceptorService: SheetInterceptorService, _selectionManagerService: SelectionManagerService);
+    constructor(_commandService: ICommandService, _refRangeService: RefRangeService, _univerInstanceService: IUniverInstanceService, _injector: Injector, _sheetInterceptorService: SheetInterceptorService, _selectionManagerService: SheetsSelectionsService);
     private _initCommandInterceptor;
     refRangeHandle(config: EffectRefRangeParams, unitId: string, subUnitId: string): {
         redos: {

package/lib/types/index.d.ts

@@ -20,6 +20,7 @@ export { convertPrimaryWithCoordToPrimary, convertSelectionDataToRange, getNorma
 export { rangeMerge, createTopMatrixFromRanges, createTopMatrixFromMatrix, findAllRectangle, RangeMergeUtil } from './basics/rangeMerge';
 export { getSheetCommandTarget, getSheetCommandTargetWorkbook, getSheetMutationTarget } from './commands/commands/utils/target-util';
 export { alignToMergedCellsBorders, getCellAtRowCol, setEndForRange, isSingleCellSelection } from './commands/commands/utils/selection-utils';
+export { getSelectionsService } from './commands/utils/selection-command-util';
 export { followSelectionOperation, getPrimaryForRange } from './commands/commands/utils/selection-utils';
 export { handleDeleteRangeMutation } from './commands/utils/handle-range-mutation';
 export { getInsertRangeMutations, getRemoveRangeMutations } from './commands/utils/handle-range-mutation';
@@ -30,7 +31,8 @@ export { BorderStyleManagerService, type IBorderInfo } from './services/border-s
 export * from './services/permission/permission-point';
 export { WorksheetPermissionService } from './services/permission/worksheet-permission/worksheet-permission.service';
 export { WorkbookPermissionService } from './services/permission/workbook-permission/workbook-permission.service';
-export { NORMAL_SELECTION_PLUGIN_NAME, SelectionManagerService, SelectionMoveType, } from './services/selection-manager.service';
+export { SheetsSelectionsService, WorkbookSelections, SelectionMoveType, DISABLE_NORMAL_SELECTIONS, } from './services/selections/selection-manager.service';
+export { IRefSelectionsService } from './services/selections/ref-selections.service';
 export { getAddMergeMutationRangeByType } from './controllers/merge-cell.controller';
 export { NumfmtService } from './services/numfmt/numfmt.service';
 export type { INumfmtItem, INumfmtItemWithCache } from './services/numfmt/type';

package/lib/types/locale/vi-VN.d.ts

@@ -0,0 +1,4 @@
+import { default as zhCN } from './zh-CN';
+
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/zh-TW.d.ts

@@ -0,0 +1,4 @@
+import { default as zhCN } from './zh-CN';
+
+declare const locale: typeof zhCN;
+export default locale;

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

@@ -1,6 +1,6 @@
 import { IMutationInfo, IRange, Nullable, Disposable, ICommandService, InterceptorManager, IUniverInstanceService } from '@univerjs/core';
 import { IDisposable } from '@wendellhu/redi';
-import { SelectionManagerService } from '../selection-manager.service';
+import { SheetsSelectionsService } from '../selections/selection-manager.service';
 import { SheetInterceptorService } from '../sheet-interceptor/sheet-interceptor.service';
 import { EffectRefRangeParams } from './type';
 
@@ -24,7 +24,7 @@ export declare class RefRangeService extends Disposable {
         MERGE_UNDO: import('@univerjs/core').IInterceptor<IMutationInfo<object>[], null>;
     }>;
     private _watchRanges;
-    constructor(_commandService: ICommandService, _sheetInterceptorService: SheetInterceptorService, _univerInstanceService: IUniverInstanceService, _selectionManagerService: SelectionManagerService);
+    constructor(_commandService: ICommandService, _sheetInterceptorService: SheetInterceptorService, _univerInstanceService: IUniverInstanceService, _selectionManagerService: SheetsSelectionsService);
     watchRange(unitId: string, subUnitId: string, range: IRange, callback: WatchRangeCallback, skipIntersects?: boolean): IDisposable;
     private _refRangeManagerMap;
     private _serializer;

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

@@ -3,26 +3,26 @@ import { IMoveColumnsMutationParams, IMoveRowsMutationParams } from '../../comma
 import { IInsertColMutationParams, IInsertRowMutationParams, IRemoveColMutationParams, IRemoveRowsMutationParams, IRemoveSheetMutationParams } from '../../basics';
 import { IMoveRangeMutationParams } from '../../commands/mutations/move-range.mutation';
 import { ISheetCommandSharedParams } from '../../commands/utils/interface';
-import { SelectionManagerService } from '../selection-manager.service';
+import { SheetsSelectionsService } from '../selections/selection-manager.service';
 import { EffectRefRangeParams, IDeleteRangeMoveLeftCommand, IDeleteRangeMoveUpCommand, IInsertColCommand, IInsertRangeMoveDownCommand, IInsertRangeMoveRightCommand, IInsertRowCommand, IMoveColsCommand, IMoveRangeCommand, IMoveRowsCommand, IOperator, IRemoveRowColCommand, IReorderRangeCommand } from './type';
 
 export declare const handleRangeTypeInput: (range: IRange) => {
-    startColumn: number;
-    endColumn: number;
     rangeType?: RANGE_TYPE;
     startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
     endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
     startRow: number;
     endRow: number;
-};
-export declare const handleRangeTypeOutput: (range: IRange, maxRow: number, maxCol: number) => {
     startColumn: number;
     endColumn: number;
+};
+export declare const handleRangeTypeOutput: (range: IRange, maxRow: number, maxCol: number) => {
     rangeType?: RANGE_TYPE;
     startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
     endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
     startRow: number;
     endRow: number;
+    startColumn: number;
+    endColumn: number;
 };
 export declare const rotateRange: (range: IRange) => IRange;
 interface ILine {
@@ -67,7 +67,7 @@ export declare const handleDeleteRangeMoveUpCommon: (param: IDeleteRangeMoveUpCo
 export declare const runRefRangeMutations: (operators: IOperator[], range: IRange) => IRange | null;
 export declare const handleDefaultRangeChangeWithEffectRefCommands: (range: IRange, commandInfo: ICommandInfo) => IRange | null;
 export declare const handleDefaultRangeChangeWithEffectRefCommandsSkipNoInterests: (range: IRange, commandInfo: ICommandInfo, deps: {
-    selectionManagerService: SelectionManagerService;
+    selectionManagerService: SheetsSelectionsService;
 }) => IRange | null;
 type MutationsAffectRange = ISheetCommandSharedParams | IRemoveSheetMutationParams | IMoveRowsMutationParams | IMoveColumnsMutationParams | IRemoveRowsMutationParams | IRemoveColMutationParams | IInsertColMutationParams | IInsertRowMutationParams | IMoveRangeMutationParams;
 export declare const handleCommonDefaultRangeChangeWithEffectRefCommands: (range: IRange, commandInfo: ICommandInfo) => IRange | IRange[] | null;
@@ -81,7 +81,7 @@ export declare const handleCommonDefaultRangeChangeWithEffectRefCommands: (range
  */
 export declare function adjustRangeOnMutation(range: Readonly<IRange>, mutation: IMutationInfo<MutationsAffectRange>): Nullable<IRange>;
 export declare function getEffectedRangesOnCommand(command: EffectRefRangeParams, deps: {
-    selectionManagerService: SelectionManagerService;
+    selectionManagerService: SheetsSelectionsService;
 }): IRange[];
 export declare function getEffectedRangesOnMutation(mutation: IMutationInfo<MutationsAffectRange>): IRange[] | undefined;
 export {};

package/lib/types/services/selections/ref-selections.service.d.ts

@@ -0,0 +1,9 @@
+import { SheetsSelectionsService } from '@univerjs/sheets';
+
+/**
+ * Ref selections service reuses code of `SelectionManagerService`. And it only contains ref selections
+ * when user is editing formula.
+ *
+ * Its data should be cleared by the caller quit editing formula and reconstructed when user starts editing.
+ */
+export declare const IRefSelectionsService: import('@wendellhu/redi').IdentifierDecorator<SheetsSelectionsService>;

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

@@ -0,0 +1,73 @@
+import { ISelectionCell, Nullable, Workbook, Disposable, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { Observable } from 'rxjs';
+import { ISelectionWithStyle } from '../../basics/selection';
+
+export interface ISelectionManagerSearchParam {
+    unitId: string;
+    sheetId: string;
+}
+export declare enum SelectionMoveType {
+    MOVE_START = 0,
+    MOVING = 1,
+    MOVE_END = 2
+}
+export declare class SheetsSelectionsService extends RxDisposable {
+    private readonly _instanceSrv;
+    private get _currentSelectionPos();
+    readonly selectionMoveStart$: Observable<Nullable<ISelectionWithStyle[]>>;
+    readonly selectionMoving$: Observable<Nullable<ISelectionWithStyle[]>>;
+    readonly selectionMoveEnd$: Observable<ISelectionWithStyle[]>;
+    constructor(_instanceSrv: IUniverInstanceService);
+    /** Clear all selections in all workbooks. */
+    clear(): void;
+    getCurrentSelections(): Readonly<ISelectionWithStyle[]>;
+    getCurrentLastSelection(): Readonly<Nullable<ISelectionWithStyle & {
+        primary: ISelectionCell;
+    }>>;
+    addSelections(selectionsData: ISelectionWithStyle[]): void;
+    addSelections(unitId: string, worksheetId: string, selectionDatas: ISelectionWithStyle[]): void;
+    setSelections(selectionDatas: ISelectionWithStyle[], type?: SelectionMoveType): void;
+    setSelections(unitId: string, worksheetId: string, selectionDatas: ISelectionWithStyle[], type?: SelectionMoveType): void;
+    clearCurrentSelections(): void;
+    /**
+     * Determine whether multiple current selections overlap
+     *
+     * @deprecated this should be extracted to an pure function
+     */
+    isOverlapping(): boolean;
+    private _getCurrentSelections;
+    getWorkbookSelections(unitId: string): WorkbookSelections;
+    private _workbookSelections;
+    private _ensureWorkbookSelection;
+}
+/**
+ * This class manages selections in a single workbook.
+ */
+export declare class WorkbookSelections extends Disposable {
+    private readonly _workbook;
+    private readonly _selectionMoveStart$;
+    readonly selectionMoveStart$: Observable<Nullable<ISelectionWithStyle[]>>;
+    private readonly _selectionMoving$;
+    readonly selectionMoving$: Observable<Nullable<ISelectionWithStyle[]>>;
+    private readonly _selectionMoveEnd$;
+    readonly selectionMoveEnd$: Observable<ISelectionWithStyle[]>;
+    private readonly _beforeSelectionMoveEnd$;
+    readonly beforeSelectionMoveEnd$: Observable<ISelectionWithStyle[]>;
+    constructor(_workbook: Workbook);
+    dispose(): void;
+    /** Clear all selections in this workbook. */
+    clear(): void;
+    addSelections(sheetId: string, selectionDatas: ISelectionWithStyle[]): void;
+    setSelections(sheetId: string, selectionDatas: ISelectionWithStyle[], type?: SelectionMoveType): void;
+    getCurrentSelections(): Readonly<ISelectionWithStyle[]>;
+    getSelectionOfWorksheet(sheetId: string): ISelectionWithStyle[];
+    private _getCurrentSelections;
+    getCurrentLastSelection(): Readonly<Nullable<ISelectionWithStyle & {
+        primary: ISelectionCell;
+    }>>;
+    private _worksheetSelections;
+    private _ensureSheetSelection;
+    private _emitOnEnd;
+}
+/** An context key to disable normal selections if its value is set to `true`. */
+export declare const DISABLE_NORMAL_SELECTIONS = "DISABLE_NORMAL_SELECTIONS";