@univerjs/core 0.1.5 → 0.1.6

package/lib/types/common/equal.d.ts

@@ -0,0 +1,20 @@
+import { IRange, IUnitRange } from '../types/interfaces';
+
+/**
+ * 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 declare const isRangesEqual: (oldRanges: IRange[], ranges: IRange[]) => boolean;
+export declare const isUnitRangesEqual: (oldRanges: IUnitRange[], ranges: IUnitRange[]) => boolean;
+export declare function shallowEqual(objA: any, objB: any): boolean;

package/lib/types/index.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { shallowEqual, isRangesEqual, isUnitRangesEqual } from './common/equal';
 export * from './basics';
 export { dedupe, remove, rotate, groupBy } from './common/array';
 export { DEFAULT_EMPTY_DOCUMENT_VALUE, DOCS_FORMULA_BAR_EDITOR_UNIT_ID_KEY, DOCS_NORMAL_EDITOR_UNIT_ID_KEY, } from './common/const';
@@ -22,6 +23,7 @@ export { requestImmediateMacroTask } from './common/request-immediate-macro-task
 export { type ISequenceExecuteResult, sequence, sequenceAsync } from './common/sequence';
 export * from './docs/data-model';
 export { TextXActionType, type TextXAction, type IDeleteAction, type IInsertAction, type IRetainAction, } from './docs/data-model/action-types';
+export { DataValidationRenderMode } from './types/enum/data-validation-render-mode';
 export { ActionIterator } from './docs/data-model/text-x/action-iterator';
 export { getBodySlice, composeBody } from './docs/data-model/text-x/utils';
 export { TextX } from './docs/data-model/text-x/text-x';
@@ -46,7 +48,7 @@ export { ResourceManagerService } from './services/resource-manager/resource-man
 export type { IResourceHook } from './services/resource-manager/type';
 export { IResourceManagerService, ISnapshotPersistenceService } from './services/resource-manager/type';
 export { type IStyleSheet, ThemeService } from './services/theme/theme.service';
-export { type IUndoRedoCommandInfos, type IUndoRedoItem, IUndoRedoService, type IUndoRedoStatus, LocalUndoRedoService, RedoCommand, UndoCommand, RedoCommandId, UndoCommandId, } from './services/undoredo/undoredo.service';
+export { type IUndoRedoCommandInfos, type IUndoRedoCommandInfosByInterceptor, type IUndoRedoItem, IUndoRedoService, type IUndoRedoStatus, LocalUndoRedoService, RedoCommand, UndoCommand, RedoCommandId, UndoCommandId, } from './services/undoredo/undoredo.service';
 export * from './shared';
 export { fromCallback } from './shared/rxjs';
 export type { IComposeInterceptors, IInterceptor, InterceptorHandler } from './common/interceptor';
@@ -75,3 +77,10 @@ export { ClientSnapshotServerService } from './services/snapshot/snapshot-server
 export { getSheetBlocksFromSnapshot } from './services/snapshot/snapshot-transform';
 export { isBlackColor, isWhiteColor } from './shared/color/color-kit';
 export { cellToRange } from './shared/common';
+export type { IDataValidationRule, IDataValidationRuleBase, IDataValidationRuleInfo, IDataValidationRuleOptions, ISheetDataValidationRule } from './types/interfaces/i-data-validation';
+export type { ICellCustomRender, ICellRenderContext } from './types/interfaces/i-cell-custom-render';
+export { DataValidationErrorStyle } from './types/enum/data-validation-error-style';
+export { DataValidationImeMode } from './types/enum/data-validation-ime-mode';
+export { DataValidationOperator } from './types/enum/data-validation-operator';
+export { DataValidationType } from './types/enum/data-validation-type';
+export { DataValidationStatus } from './types/enum/data-validation-status';

package/lib/types/services/lifecycle/lifecycle.d.ts

@@ -30,7 +30,37 @@ export declare const LifecycleNameMap: {
 };
 export declare const LifecycleToModules: Map<LifecycleStages, DependencyIdentifier<unknown>[]>;
 /**
- * Register some modules here that will automatically run when Univer progressed to a certain lifecycle stage
+ * Register the decorated class to be automatically instantiated when Univer progresses to the certain lifecycle stage.
+ *
+ * @param lifecycleStage The lifecycle stage to instantiate this class.
+ * @param identifier The dependency identifier of the class. Usually, it is the class itself unless you bind this class
+ * with another injection identifier.
+ *
+ *
+ * @example
+ * // Ignore the `\` below. This is JSDoc's bug.
+ * \@OnLifecycle(LifecycleStages.Ready, MyService)
+ * class MyService {
+ * }
+ *
+ * @example
+ * // Ignore the `\` below. This is JSDoc's bug.
+ * \@OnLifecycle(LifecycleStages.Rendered, IMyService)
+ * class MyService implements IMyService {
+ * }
  */
 export declare function OnLifecycle(lifecycleStage: LifecycleStages, identifier: DependencyIdentifier<unknown>): (_: Ctor<unknown>) => void;
+/**
+ * Register a dependency to be automatically instantiated when Univer progresses to the certain lifecycle stage.
+ *
+ * @param lifecycleStage The lifecycle stage to instantiate this dependency.
+ * @param identifier The dependencies' identifier. **Beware** that if the dependency (e.g. a class) is bound to an
+ * identifier, you should register the identifier instead of the dependency itself.
+ *
+ * @example
+ * runOnLifecycle(LifecycleStages.Ready, MyService);
+ *
+ * @example
+ * runOnLifecycle(LifecycleStages.Rendered, IMyService);
+ */
 export declare function runOnLifecycle(lifecycleStage: LifecycleStages, identifier: DependencyIdentifier<unknown>): void;

package/lib/types/services/undoredo/undoredo.service.d.ts

@@ -30,6 +30,16 @@ export interface IUndoRedoService {
      */
     __tempBatchingUndoRedo(unitId: string): IDisposable;
 }
+export interface IUndoRedoCommandInfosByInterceptor {
+    /**
+     * Sometimes, mutations generated by interceptors need to ensure a certain execution order
+     * PreMutations run before user's intent to make sure the undo/redo works correctly.
+     */
+    preUndos?: IMutationInfo[];
+    undos: IMutationInfo[];
+    redos: IMutationInfo[];
+    preRedos?: IMutationInfo[];
+}
 export interface IUndoRedoCommandInfos {
     undos: IMutationInfo[];
     redos: IMutationInfo[];

package/lib/types/shared/index.d.ts

@@ -36,3 +36,4 @@ export * from './sort-rules';
 export * from './tools';
 export * from './types';
 export * from './debounce';
+export { queryObjectMatrix } from './object-matrix-query';

package/lib/types/shared/object-matrix-query.d.ts

@@ -0,0 +1,4 @@
+import { ObjectMatrix } from './object-matrix';
+import { IRange } from '../types/interfaces';
+
+export declare function queryObjectMatrix<T>(matrix: ObjectMatrix<T>, match: (value: T) => boolean): IRange[];

package/lib/types/shared/object-matrix.d.ts

@@ -12,7 +12,7 @@ export interface IObjectArrayPrimitiveType<T> {
 }
 export declare function getArrayLength<T>(o: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>): number;
 export declare function insertMatrixArray<T>(index: number, value: T, o: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>): void;
-export declare function spliceArray<T>(start: number, count: number, o: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>, insert?: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>): IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>;
+export declare function spliceArray<T>(start: number, count: number, o: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>): void;
 export declare function concatMatrixArray<T>(source: IObjectArrayPrimitiveType<T>, target: IObjectArrayPrimitiveType<T>): IObjectArrayPrimitiveType<T>;
 export declare function sliceMatrixArray<T>(start: number, end: number, matrixArray: IObjectArrayPrimitiveType<T>): IObjectArrayPrimitiveType<T>;
 export declare function moveMatrixArray<T>(fromIndex: number, count: number, toIndex: number, o: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>): void;
@@ -81,6 +81,7 @@ export declare class ObjectMatrix<T> {
     getRange(): IRange;
     toNativeArray(): T[];
     toArray(): T[][];
+    toFullArray(): T[][];
     /**
      * @deprecated Use getMatrix as a substitute.
      */

package/lib/types/shared/tools.d.ts

@@ -95,4 +95,6 @@ export declare class Tools {
     static commonExtend1<T>(originJson: IKeyValue, extendJson: IKeyValue): T;
     static arrayToObject(array: IKeyValue[][]): IKeyValue;
     static hasIntersectionBetweenTwoRanges(range1Start: number, range1End: number, range2Start: number, range2End: number): boolean;
+    static isStartValidPosition(name: string): boolean;
+    static isValidParameter(name: string): boolean;
 }

package/lib/types/sheets/empty-snapshot.d.ts

@@ -0,0 +1,4 @@
+import { IWorkbookData } from '../types/interfaces';
+import { LocaleType } from '../types/enum/locale-type';
+
+export declare function getEmptySnapshot(unitID?: string, locale?: LocaleType, name?: string): IWorkbookData;

package/lib/types/sheets/view-model.d.ts

@@ -4,7 +4,7 @@ import { Nullable } from '../common/type-utils';
 import { IDisposable } from '@wendellhu/redi';
 
 export interface ICellContentInterceptor {
-    getCell(row: number, col: number): Nullable<ICellDataForSheetInterceptor>;
+    getCell: (row: number, col: number) => Nullable<ICellDataForSheetInterceptor>;
 }
 export interface IRowFilteredInterceptor {
 }
@@ -13,11 +13,11 @@ export interface IRowVisibleInterceptor {
 export interface IColVisibleInterceptor {
 }
 export interface ISheetViewModel {
-    registerCellContentInterceptor(interceptor: ICellContentInterceptor): IDisposable;
-    registerRowFilteredInterceptor(interceptor: IRowFilteredInterceptor): IDisposable;
-    registerRowVisibleInterceptor(interceptor: IRowVisibleInterceptor): IDisposable;
-    registerColVisibleInterceptor(interceptor: IColVisibleInterceptor): IDisposable;
-    getCell(row: number, col: number): Nullable<ICellDataForSheetInterceptor>;
+    registerCellContentInterceptor: (interceptor: ICellContentInterceptor) => IDisposable;
+    registerRowFilteredInterceptor: (interceptor: IRowFilteredInterceptor) => IDisposable;
+    registerRowVisibleInterceptor: (interceptor: IRowVisibleInterceptor) => IDisposable;
+    registerColVisibleInterceptor: (interceptor: IColVisibleInterceptor) => IDisposable;
+    getCell: (row: number, col: number) => Nullable<ICellDataForSheetInterceptor>;
 }
 /**
  * SheetViewModel

package/lib/types/types/const/const.d.ts

@@ -1,4 +1,3 @@
-import { IWorkbookData } from '../interfaces';
 import { BooleanNumber, HorizontalAlign, TextDirection, VerticalAlign, WrapStrategy } from '../enum';
 
 /**
@@ -38,10 +37,6 @@ export declare const DEFAULT_CELL: {
     row: number;
     column: number;
 };
-/**
- * Used as an init workbook return value
- */
-export declare const DEFAULT_WORKBOOK: IWorkbookData;
 /**
  * Default styles.
  */

package/lib/types/types/enum/data-validation-error-style.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 declare enum DataValidationErrorStyle {
+    INFO = 0,
+    STOP = 1,
+    WARNING = 2
+}

package/lib/types/types/enum/data-validation-ime-mode.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 declare enum DataValidationImeMode {
+    DISABLED = 0,
+    FULL_ALPHA = 1,
+    FULL_HANGUL = 2,
+    FULL_KATAKANA = 3,
+    HALF_ALPHA = 4,
+    HALF_HANGUL = 5,
+    HALF_KATAKANA = 6,
+    HIRAGANA = 7,
+    NO_CONTROL = 8,
+    OFF = 9,
+    ON = 10
+}

package/lib/types/types/enum/data-validation-operator.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 declare enum DataValidationOperator {
+    BETWEEN = "between",
+    EQUAL = "equal",
+    GREATER_THAN = "greaterThan",
+    GREATER_THAN_OR_EQUAL = "greaterThanOrEqual",
+    LESS_THAN = "lessThan",
+    LESS_THAN_OR_EQUAL = "lessThanOrEqual",
+    NOT_BETWEEN = "notBetween",
+    NOT_EQUAL = "notEqual"
+}

package/lib/types/types/enum/data-validation-render-mode.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 declare enum DataValidationRenderMode {
+    TEXT = 0,
+    ARROW = 1,
+    CUSTOM = 2
+}

package/lib/types/types/enum/data-validation-status.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 declare enum DataValidationStatus {
+    VALID = "valid",
+    INVALID = "invalid",
+    VALIDATING = "validating"
+}

package/lib/types/types/enum/data-validation-type.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 declare enum DataValidationType {
+    /**
+     * custom formula
+     */
+    CUSTOM = "custom",
+    LIST = "list",
+    LIST_MULTIPLE = "listMultiple",
+    NONE = "none",
+    TEXT_LENGTH = "textLength",
+    DATE = "date",
+    TIME = "time",
+    /**
+     * integer number
+     */
+    WHOLE = "whole",
+    /**
+     * decimal number
+     */
+    DECIMAL = "decimal",
+    CHECKBOX = "checkbox"
+}

package/lib/types/types/interfaces/i-cell-custom-render.d.ts

@@ -0,0 +1,28 @@
+import { ICellDataForSheetInterceptor } from './i-cell-data';
+import { IStyleData } from './i-style-data';
+import { ISelectionCellWithCoord } from './i-selection-data';
+import { Nullable } from '../../shared';
+
+export interface ICellRenderContext {
+    data: ICellDataForSheetInterceptor;
+    style: Nullable<IStyleData>;
+    primaryWithCoord: ISelectionCellWithCoord;
+    unitId?: string;
+    subUnitId: string;
+    row: number;
+    col: number;
+}
+/**
+ * @debt This shouldn't exist in core package.
+ */
+export interface ICellCustomRender {
+    drawWith(ctx: CanvasRenderingContext2D, info: ICellRenderContext, skeleton: any, spreadsheets: any): void;
+    zIndex?: number;
+    isHit?: (position: {
+        x: number;
+        y: number;
+    }, info: ICellRenderContext) => boolean;
+    onPointerDown?: (info: ICellRenderContext, evt: any) => void;
+    onPointerEnter?: (info: ICellRenderContext, evt: any) => void;
+    onPointerLeave?: (info: ICellRenderContext, evt: any) => void;
+}

package/lib/types/types/interfaces/i-cell-data.d.ts

@@ -1,5 +1,7 @@
+import { ICellValidationData } from './i-cell-validation-data';
 import { IStyleData } from './i-style-data';
 import { IDocumentData } from './i-document-data';
+import { ICellCustomRender } from './i-cell-custom-render';
 import { CellValueType } from '../enum/text-style';
 import { Nullable } from '../../shared/types';
 
@@ -32,9 +34,23 @@ export interface ICellData {
      */
     si?: Nullable<string>;
 }
+export interface ICellMarksStyle {
+    color: string;
+    size: number;
+}
+export interface ICellMarks {
+    tl?: ICellMarksStyle;
+    tr?: ICellMarksStyle;
+    bl?: ICellMarksStyle;
+    br?: ICellMarksStyle;
+}
 export interface ICellDataForSheetInterceptor extends ICellData {
     interceptorStyle?: Nullable<IStyleData>;
     isInArrayFormulaRange?: Nullable<boolean>;
+    dataValidation?: Nullable<ICellValidationData>;
+    markers?: ICellMarks;
+    customRender?: Nullable<ICellCustomRender[]>;
+    interceptorAutoHeight?: number;
 }
 export declare function isICellData(value: any): value is ICellData;
 export declare function getCellValueType(cell: ICellData): CellValueType | null | undefined;

package/lib/types/types/interfaces/i-cell-validation-data.d.ts

@@ -0,0 +1,9 @@
+import { IDataValidationRule } from './i-data-validation';
+import { DataValidationStatus } from '../enum/data-validation-status';
+
+export interface ICellValidationData {
+    ruleId: string;
+    validStatus: DataValidationStatus;
+    rule: IDataValidationRule;
+    validator: any;
+}

package/lib/types/types/interfaces/i-data-validation.d.ts

@@ -0,0 +1,44 @@
+import { IRange } from './i-range';
+import { DataValidationRenderMode } from '../enum/data-validation-render-mode';
+import { DataValidationErrorStyle } from '../enum/data-validation-error-style';
+import { DataValidationImeMode } from '../enum/data-validation-ime-mode';
+import { DataValidationType } from '../enum/data-validation-type';
+import { DataValidationOperator } from '../enum/data-validation-operator';
+
+export interface IDataValidationRuleBase {
+    type: DataValidationType;
+    allowBlank?: boolean;
+    formula1?: string;
+    formula2?: string;
+    operator?: DataValidationOperator;
+}
+export interface IDataValidationRuleOptions {
+    error?: string;
+    errorStyle?: DataValidationErrorStyle;
+    errorTitle?: string;
+    imeMode?: DataValidationImeMode;
+    prompt?: string;
+    promptTitle?: string;
+    showDropDown?: boolean;
+    showErrorMessage?: boolean;
+    showInputMessage?: boolean;
+    /**
+     * cell render mode of data validation
+     */
+    renderMode?: DataValidationRenderMode;
+}
+export interface IDataValidationRule extends IDataValidationRuleBase, IDataValidationRuleOptions {
+    uid: string;
+    /**
+     * @debt should using specific type cover sheet、doc、slide range type
+     */
+    ranges: any;
+}
+export interface ISheetDataValidationRule extends IDataValidationRule {
+    ranges: IRange[];
+}
+export interface IDataValidationRuleInfo {
+    rule: IDataValidationRule;
+    unitId: string;
+    subUnitId: string;
+}