@univerjs/core 0.2.8 → 0.2.10

package/lib/types/sheets/typedef.d.ts

@@ -0,0 +1,451 @@
+import { LocaleType } from '../types/enum/locale-type';
+import { IStyleData } from '../types/interfaces/i-style-data';
+import { IResources } from '../services/resource-manager/type';
+import { IObjectArrayPrimitiveType, IObjectMatrixPrimitiveType, Nullable } from '../shared';
+import { BooleanNumber, CellValueType } from '../types/enum';
+import { IDocumentData } from '../types/interfaces';
+import { ICellCustomRender } from '../types/interfaces/i-cell-custom-render';
+import { ICellValidationData } from '../types/interfaces/i-cell-validation-data';
+/**
+ * Snapshot of a workbook.
+ */
+export interface IWorkbookData {
+    /**
+     * Id of the Univer Sheet.
+     */
+    id: string;
+    /**
+     * Revision of this spreadsheet. Used in collaborated editing. Starts from one.
+     * @ignore
+     */
+    rev?: number;
+    /**
+     * Name of the Univer Sheet.
+     */
+    name: string;
+    /**
+     * Version of Univer model definition.
+     */
+    appVersion: string;
+    /**
+     * Locale of the document.
+     */
+    locale: LocaleType;
+    /**
+     * Style references.
+     */
+    styles: Record<string, Nullable<IStyleData>>;
+    /** Ids of {@link IWorksheetData}s of this Univer Sheet in sequence order. */
+    sheetOrder: string[];
+    /**
+     * Data of each {@link IWorksheetData} in this Univer Sheet.
+     */
+    sheets: {
+        [sheetId: string]: Partial<IWorksheetData>;
+    };
+    /**
+     * Resources of the Univer Sheet. It is used to store the data of other plugins.
+     */
+    resources?: IResources;
+}
+/**
+ * Snapshot of a worksheet.
+ */
+export interface IWorksheetData {
+    /**
+     * Id of the worksheet. This should be unique and immutable across the lifecycle of the worksheet.
+     */
+    id: string;
+    /** Name of the sheet. */
+    name: string;
+    tabColor: string;
+    /**
+     * Determine whether the sheet is hidden.
+     *
+     * @remarks
+     * See {@link BooleanNumber| the BooleanNumber enum} for more details.
+     *
+     * @defaultValue `BooleanNumber.FALSE`
+     */
+    hidden: BooleanNumber;
+    freeze: IFreeze;
+    rowCount: number;
+    columnCount: number;
+    /** @deprecated */
+    zoomRatio: number;
+    /** @deprecated */
+    scrollTop: number;
+    /** @deprecated */
+    scrollLeft: number;
+    defaultColumnWidth: number;
+    defaultRowHeight: number;
+    /** All merged cells in this worksheet. */
+    mergeData: IRange[];
+    /** A matrix storing cell contents by row and column index. */
+    cellData: IObjectMatrixPrimitiveType<ICellData>;
+    rowData: IObjectArrayPrimitiveType<Partial<IRowData>>;
+    columnData: IObjectArrayPrimitiveType<Partial<IColumnData>>;
+    rowHeader: {
+        width: number;
+        hidden?: BooleanNumber;
+    };
+    columnHeader: {
+        height: number;
+        hidden?: BooleanNumber;
+    };
+    showGridlines: BooleanNumber;
+    rightToLeft: BooleanNumber;
+}
+/**
+ * Properties of row data
+ */
+export interface IRowData {
+    /**
+     * height in pixel
+     */
+    h?: number;
+    /**
+     * is current row self-adaptive to its content, use `ah` to set row height when true, else use `h`.
+     */
+    ia?: BooleanNumber;
+    /**
+     * auto height
+     */
+    ah?: number;
+    /**
+     * hidden
+     */
+    hd?: BooleanNumber;
+}
+export interface IRowAutoHeightInfo {
+    row: number;
+    autoHeight?: number;
+}
+/**
+ * Properties of column data
+ */
+export interface IColumnData {
+    /**
+     * width
+     */
+    w?: number;
+    /**
+     * hidden
+     */
+    hd?: BooleanNumber;
+}
+/**
+ * Cell value type
+ */
+export type CellValue = string | number | boolean;
+/**
+ * Cell data
+ */
+export interface ICellData {
+    /**
+     * The unique key, a random string, is used for the plug-in to associate the cell. When the cell information changes,
+     * the plug-in does not need to change the data, reducing the pressure on the back-end interface id?: string.
+     */
+    p?: Nullable<IDocumentData>;
+    /** style id */
+    s?: Nullable<IStyleData | string>;
+    /**
+     * Origin value
+     */
+    v?: Nullable<CellValue>;
+    t?: Nullable<CellValueType>;
+    /**
+     * Raw formula string. For example `=SUM(A1:B4)`.
+     */
+    f?: Nullable<string>;
+    /**
+     * Id of the formula.
+     */
+    si?: Nullable<string>;
+    /**
+     * User stored custom fields
+     */
+    custom?: Nullable<Record<string, any>>;
+}
+export interface ICellMarksStyle {
+    color: string;
+    size: number;
+}
+export interface ICellMarks {
+    tl?: ICellMarksStyle;
+    tr?: ICellMarksStyle;
+    bl?: ICellMarksStyle;
+    br?: ICellMarksStyle;
+    isSkip?: boolean;
+}
+export interface ICellDataForSheetInterceptor extends ICellData {
+    interceptorStyle?: Nullable<IStyleData>;
+    isInArrayFormulaRange?: Nullable<boolean>;
+    dataValidation?: Nullable<ICellValidationData>;
+    markers?: ICellMarks;
+    customRender?: Nullable<ICellCustomRender[]>;
+    interceptorAutoHeight?: () => number | undefined;
+    /**
+     * can cell be covered when sibling is overflow
+     */
+    coverable?: boolean;
+}
+export declare function isICellData(value: any): value is ICellData;
+export declare function getCellValueType(cell: ICellData): CellValueType | null | undefined;
+export declare function isNullCell(cell: Nullable<ICellData>): boolean;
+export declare function isCellV(cell: Nullable<ICellData | CellValue>): cell is string | number | boolean;
+export interface IFreeze {
+    xSplit: number;
+    ySplit: number;
+    startRow: number;
+    startColumn: number;
+}
+export declare enum RANGE_TYPE {
+    NORMAL = 0,
+    ROW = 1,
+    COLUMN = 2,
+    ALL = 3
+}
+/**
+ * none: A1
+ * row: A$1
+ * column: $A1
+ * all: $A$1
+ */
+export declare enum AbsoluteRefType {
+    NONE = 0,
+    ROW = 1,
+    COLUMN = 2,
+    ALL = 3
+}
+interface IRangeLocation {
+    /**
+     * Id of the Workbook the range belongs to.
+     * When this field is not defined, it should be considered as the range in the currently activated worksheet.
+     */
+    unitId?: string;
+    /**
+     * Id of the Worksheet the range belongs to.
+     * When this field is not defined, it should be considered as the range in the currently activated worksheet.
+     */
+    sheetId?: string;
+}
+export interface IRowRange extends IRangeLocation {
+    /**
+     * The start row (inclusive) of the range
+     * startRow
+     */
+    startRow: number;
+    /**
+     * The end row (exclusive) of the range
+     * endRow
+     */
+    endRow: number;
+}
+export interface IColumnRange extends IRangeLocation {
+    /**
+     * The start column (inclusive) of the range
+     * startColumn
+     */
+    startColumn: number;
+    /**
+     * The end column (exclusive) of the range
+     * endColumn
+     */
+    endColumn: number;
+}
+/**
+ * Range data structure
+ *
+ * One of the range types,
+ *
+ * e.g.,
+ * {
+ *    startRow:0 ,
+ *    startColumn:0,
+ *    endRow:1,
+ *    endColumn:1,
+ * }
+ *
+ * means "A1:B2"
+ */
+export interface IRange extends IRowRange, IColumnRange {
+    rangeType?: RANGE_TYPE;
+    startAbsoluteRefType?: AbsoluteRefType;
+    endAbsoluteRefType?: AbsoluteRefType;
+}
+/**
+ * Transform an `IRange` object to an array.
+ * @param range
+ * @returns [rowStart, colStart, rowEnd, colEnd]
+ */
+export declare function selectionToArray(range: IRange): [number, number, number, number];
+/**
+ * Range data of grid
+ */
+export interface IGridRange {
+    sheetId: string;
+    range: IRange;
+}
+export interface IUnitRangeName {
+    unitId: string;
+    sheetName: string;
+    range: IRange;
+}
+/**
+ * Range data of Unit
+ */
+export interface IUnitRange extends IGridRange {
+    unitId: string;
+}
+export interface IUnitRangeWithName extends IUnitRange {
+    sheetName: string;
+}
+/**
+ * One of the range types,
+ *
+ * e.g.,"A1:B2","sheet1!A1:B2","A1","1:1","A:A","AA1:BB2"
+ */
+export type IRangeStringData = string;
+/**
+ * Row data type
+ */
+export type IRowStartEndData = [startRow: number, endRow: number] | number[];
+/**
+ * Column data type
+ */
+export type IColumnStartEndData = [startColumn: number, endColumn: number] | number[];
+/**
+ * One of the range types,
+ *
+ * e.g.,
+ * {
+ *  row:[0,1],
+ *  column:[0,1]
+ * }
+ *todo
+
+ true false 枚举
+ * means "A1:B2"
+ */
+export interface IRangeArrayData {
+    /**
+     * row
+     */
+    row: IRowStartEndData;
+    /**
+     * column
+     */
+    column: IColumnStartEndData;
+}
+/**
+ * The row and column numbers represent a cell
+ */
+export interface IRangeCellData {
+    /**
+     * row
+     */
+    row: number;
+    /**
+     * column
+     */
+    column: number;
+}
+/**
+ * range types
+ *
+ * Allow users to provide one of three formats, we need to convert to IRange to store
+ */
+export type IRangeType = IRange | IRangeStringData | IRangeArrayData | IRangeCellData;
+/**
+ * Whether to clear only the contents.	Whether to clear only the format; note that clearing format also clears data validation rules.
+ */
+export interface IOptionData {
+    /**
+     * 1. designates that only the format should be copied
+     *
+     * 2. Whether to clear only the format; note that clearing format also clears data validation rules.
+     *
+     * 3. worksheet Whether to clear the format.
+     */
+    formatOnly?: boolean;
+    /**
+     * 1. designates that only the content should be copied
+     *
+     * 2. Whether to clear only the contents.
+     *
+     * 3. worksheet Whether to clear the content.
+     *
+     */
+    contentsOnly?: boolean;
+}
+/**
+ * Option of copyTo function
+ */
+export interface ICopyToOptionsData extends IOptionData {
+}
+export interface IRectLTRB {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    width?: number;
+    height?: number;
+}
+/**
+ * Properties of selection data
+ */
+export interface IPosition {
+    startX: number;
+    startY: number;
+    endX: number;
+    endY: number;
+}
+export interface ISingleCell {
+    actualRow: number;
+    actualColumn: number;
+    isMerged: boolean;
+    isMergedMainCell: boolean;
+}
+export interface IRangeWithCoord extends IPosition, IRange {
+}
+export interface ISelectionCell extends IRange, ISingleCell {
+}
+export interface ISelectionCellWithMergeInfo extends IPosition, ISingleCell {
+    mergeInfo: IRangeWithCoord;
+}
+export interface ISelection {
+    /**
+     * Sheet selection range.
+     */
+    range: IRange;
+    /**
+     * The highlighted cell in the selection range. If there are several selections, only one selection would have a primary cell.
+     */
+    primary: Nullable<ISelectionCell>;
+}
+/**
+ * Selection range Info, contains selectionrange & primaryrange
+ * primaryrange is the range of the highlighted cell.
+ */
+export interface ISelectionWithCoord {
+    rangeWithCoord: IRangeWithCoord;
+    primaryWithCoord: Nullable<ISelectionCellWithMergeInfo>;
+}
+export interface ITextRangeStart {
+    startOffset: number;
+}
+export interface ITextRange extends ITextRangeStart {
+    endOffset: number;
+    collapsed: boolean;
+}
+export interface ITextRangeParam extends ITextRange {
+    segmentId?: string;
+    segmentPage?: number;
+    isActive?: boolean;
+}
+/**
+ * Determines whether the cell(row, column) is within the range of the merged cells.
+ */
+export declare function getCellInfoInMergeData(row: number, column: number, mergeData?: IRange[]): ISelectionCell;
+export {};

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

@@ -0,0 +1,3 @@
+import { IRange, IUnitRange } from './typedef';
+export declare const isRangesEqual: (oldRanges: IRange[], ranges: IRange[]) => boolean;
+export declare const isUnitRangesEqual: (oldRanges: IUnitRange[], ranges: IUnitRange[]) => boolean;

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

@@ -1,7 +1,7 @@
 import { IDisposable } from '../common/di';
-import { Nullable } from '../common/type-util';
 import { Disposable } from '../shared/lifecycle';
-import { ICellData, ICellDataForSheetInterceptor } from '../types/interfaces/i-cell-data';
+import { Nullable } from '../shared/types';
+import { ICellData, ICellDataForSheetInterceptor } from './typedef';
 /**
  * @internal
  */

package/lib/types/sheets/workbook.d.ts

@@ -1,10 +1,10 @@
 import { Observable } from 'rxjs';
 import { ILogService } from '../services/log/log.service';
 import { Nullable } from '../shared';
-import { IRangeType, IWorkbookData, IWorksheetData } from '../types/interfaces';
 import { UnitModel, UniverInstanceType } from '../common/unit';
 import { Styles } from './styles';
 import { Worksheet } from './worksheet';
+import { IRangeType, IWorkbookData, IWorksheetData } from './typedef';
 export declare function getWorksheetUID(workbook: Workbook, worksheet: Worksheet): string;
 /**
  * Access and create Univer Sheets files
@@ -39,10 +39,21 @@ export declare class Workbook extends UnitModel<IWorkbookData, UniverInstanceTyp
     private readonly _name$;
     readonly name$: Observable<string>;
     get name(): string;
+    static isIRangeType(range: IRangeType | IRangeType[]): boolean;
     constructor(workbookData: Partial<IWorkbookData> | undefined, _logService: ILogService);
     dispose(): void;
+    /**
+     * Create a clone of the current snapshot.
+     * Call resourceLoaderService.saveWorkbook to save the data associated with the current plugin if needed.
+     * @memberof Workbook
+     */
     save(): IWorkbookData;
-    static isIRangeType(range: IRangeType | IRangeType[]): boolean;
+    /**
+     * Get current snapshot reference.
+     * Call resourceLoaderService.saveWorkbook to save the data associated with the current plugin if needed.
+     * @return {*}  {IWorkbookData}
+     * @memberof Workbook
+     */
     getSnapshot(): IWorkbookData;
     /** @deprecated use use name property instead */
     getName(): string;
@@ -50,8 +61,6 @@ export declare class Workbook extends UnitModel<IWorkbookData, UniverInstanceTyp
     getUnitId(): string;
     getRev(): number;
     incrementRev(): void;
-    getShouldRenderLoopImmediately(): boolean;
-    getContainer(): string | undefined;
     /**
      * Add a Worksheet into Workbook.
      */

package/lib/types/sheets/worksheet.d.ts

@@ -1,10 +1,10 @@
 import { Nullable, ObjectMatrix } from '../shared';
 import { BooleanNumber } from '../types/enum';
-import { ICellData, ICellDataForSheetInterceptor, IFreeze, IRange, IWorksheetData } from '../types/interfaces';
 import { ColumnManager } from './column-manager';
 import { Range } from './range';
 import { RowManager } from './row-manager';
 import { Styles } from './styles';
+import { ICellData, ICellDataForSheetInterceptor, IFreeze, IRange, IWorksheetData } from './typedef';
 import { SheetViewModel } from './view-model';
 /**
  * The model of a Worksheet.
@@ -72,6 +72,16 @@ export declare class Worksheet {
     clone(): Worksheet;
     getMergeData(): IRange[];
     getMergedCell(row: number, col: number): Nullable<IRange>;
+    /**
+     * Get cellData, includes cellData, customRender, markers, dataValidate, etc.
+     *
+     * WARNING: All sheet CELL_CONTENT interceptors will be called in this method, cause performance issue.
+     * example: this._sheetInterceptorService.intercept(INTERCEPTOR_POINT.CELL_CONTENT);
+     *
+     * @param row
+     * @param col
+     * @returns ICellDataForSheetInterceptor
+     */
     getCell(row: number, col: number): Nullable<ICellDataForSheetInterceptor>;
     getCellRaw(row: number, col: number): Nullable<ICellData>;
     getRowFiltered(row: number): boolean;

package/lib/types/slides/slide-model.d.ts

@@ -13,7 +13,6 @@ export declare class SlideDataModel extends UnitModel<ISlideData, UniverInstance
     private _unitId;
     constructor(snapshot: Partial<ISlideData>);
     setName(name: string): void;
-    getContainer(): string | undefined;
     getSnapshot(): ISlideData;
     getUnitId(): string;
     getPages(): {

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

@@ -136,3 +136,7 @@ export declare const DEFAULT_SLIDE: {
         height: number;
     };
 };
+/**
+ * Univer internal key on cellData.custom to save some internal values
+ */
+export declare const UNIVER_INTERNAL = "__univer_internal__";

package/lib/types/types/enum/locale-type.d.ts

@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Built-in locales.
+ */
 export declare enum LocaleType {
     EN_US = "enUS",
     ZH_CN = "zhCN",
@@ -20,4 +23,3 @@ export declare enum LocaleType {
     ZH_TW = "zhTW",
     VI_VN = "viVN"
 }
-export type LocaleTypes = `${LocaleType}`;

package/lib/types/types/enum/text-style.d.ts

@@ -111,7 +111,7 @@ export declare enum BaselineOffset {
 /**
  * General Boolean Enum
  */
-export declare enum BooleanNumber {
+export declare const enum BooleanNumber {
     FALSE = 0,
     TRUE = 1
 }

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

@@ -1,9 +1,8 @@
 import { Nullable } from '../../shared';
 import { Worksheet } from '../../sheets/worksheet';
 import { Workbook } from '../../sheets/workbook';
-import { ISelectionCellWithMergeInfo } from './i-selection-data';
+import { ICellDataForSheetInterceptor, ISelectionCellWithMergeInfo } from '../../sheets/typedef';
 import { IStyleData } from './i-style-data';
-import { ICellDataForSheetInterceptor } from './i-cell-data';
 export interface ICellRenderContext {
     data: ICellDataForSheetInterceptor;
     style: Nullable<IStyleData>;
@@ -17,6 +16,7 @@ export interface ICellRenderContext {
 }
 /**
  * @debt This shouldn't exist in core package.
+ * @ignore
  *
  * @deprecated This interface is subject to change in the future.
  */

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

@@ -3,7 +3,7 @@ import { DataValidationType } from '../enum/data-validation-type';
 import { DataValidationImeMode } from '../enum/data-validation-ime-mode';
 import { DataValidationErrorStyle } from '../enum/data-validation-error-style';
 import { DataValidationRenderMode } from '../enum/data-validation-render-mode';
-import { IRange } from './i-range';
+import { IRange } from '../../sheets/typedef';
 export interface IDataValidationRuleBase {
     type: DataValidationType;
     allowBlank?: boolean;

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

@@ -1,12 +1,11 @@
-import { Nullable } from '../../common/type-util';
 import { IAbsoluteTransform, ISize } from '../../shared/shape';
+import { Nullable } from '../../shared/types';
 import { BooleanNumber, CellValueType, HorizontalAlign, LocaleType, TextDirection, VerticalAlign, WrapStrategy } from '../enum';
-import { IExtraModelData } from './i-extra-model-data';
 import { IColorStyle, IStyleBase } from './i-style-data';
 /**
  * Properties of document
  */
-export interface IDocumentData extends IReferenceSource, IExtraModelData {
+export interface IDocumentData extends IReferenceSource {
     /** unit ID */
     id: string;
     /** Revision of this document. Would be used in collaborated editing. Starts with zero. */
@@ -148,7 +147,6 @@ export interface IListData {
  */
 export interface INestingLevel {
     paragraphProperties?: IParagraphStyle;
-    paragraphTextStyle?: ITextStyle;
     bulletAlignment: BulletAlignment;
     glyphFormat: string;
     textStyle?: ITextStyle;

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

@@ -1,15 +1,14 @@
 import { ISize } from '../../shared/shape';
 import { IKeyType, Nullable } from '../../shared/types';
+import { IWorksheetData } from '../../sheets/typedef';
 import { LocaleType, ThemeColorType } from '../enum';
 import { ShapeType } from '../enum/prst-geom-type';
 import { ICustomBlock, IDocumentData, ILists, ITransformState } from './i-document-data';
-import { IExtraModelData } from './i-extra-model-data';
 import { IImageProperties } from './i-image-properties';
 import { IPlaceholder } from './i-placeholder';
 import { IShapeProperties } from './i-shape-properties';
 import { IColorStyle, IStyleBase, IStyleData } from './i-style-data';
-import { IWorksheetData } from './i-worksheet-data';
-export interface ISlideData extends IReferenceSource, IExtraModelData {
+export interface ISlideData extends IReferenceSource {
     id: string;
     locale?: LocaleType;
     title: string;
@@ -96,11 +95,14 @@ export interface IPageElement {
     shape?: IShape;
     image?: IImage;
     richText?: IRichTextProps;
+    /** @deprecated */
     spreadsheet?: {
         worksheet: IWorksheetData;
         styles: IKeyType<Nullable<IStyleData>>;
     };
+    /** @deprecated */
     document?: IDocumentData;
+    /** @deprecated */
     slide?: ISlideData;
     customBlock?: ICustomBlock;
 }

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

@@ -13,21 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './i-cell-data';
-export * from './i-column-data';
 export * from './i-document-data';
 export * from './i-document-data-interceptor';
-export * from './i-freeze';
 export * from './i-image-properties';
 export * from './i-placeholder';
-export * from './i-range';
-export * from './i-row-data';
-export * from './i-selection-data';
-export * from './i-service-data';
 export * from './i-shape-properties';
 export * from './i-slide-data';
 export * from './i-style-data';
-export * from './i-univer-data';
-export * from './i-workbook-data';
-export * from './i-worksheet-data';
-export * from './i-worksheet-order-data';