@univerjs/core 0.1.1 → 0.1.3

package/lib/types/sheets/__tests__/create-core-test-bed.d.ts

@@ -13,10 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { Dependency } from '@wendellhu/redi';
 import { Univer } from '../../basics/univer';
 import type { IWorkbookData } from '../../types/interfaces/i-workbook-data';
-export declare function createCoreTestBed(workbookConfig?: IWorkbookData, dependencies?: Dependency[]): {
+export declare function createCoreTestBed(workbookConfig?: IWorkbookData): {
     univer: Univer;
     get: {
         <T>(id: import("@wendellhu/redi").DependencyIdentifier<T>, lookUp?: import("@wendellhu/redi").LookUp | undefined): T;

package/lib/types/sheets/__tests__/worksheet.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/sheets/row-manager.d.ts

@@ -18,8 +18,6 @@ import type { Nullable } from '../shared/types';
 import type { IRange, IRowData, IWorksheetData } from '../types/interfaces';
 /**
  * Manage configuration information of all rows, get row height, row length, set row height, etc.
- *
- * @deprecated This class is not necessary. It increases the complexity of the code and does not bring any benefits.
  */
 export declare class RowManager {
     private readonly _config;

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

@@ -66,6 +66,7 @@ export declare class Workbook extends Disposable {
      */
     addWorksheet(id: string, index: number, worksheetSnapshot: Partial<IWorksheetData>): boolean;
     getParentRenderUnitId(): string | undefined;
+    getSheetOrders(): Readonly<string[]>;
     getWorksheets(): Map<string, Worksheet>;
     getActiveSpreadsheet(): Workbook;
     getStyles(): Styles;

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

@@ -23,11 +23,10 @@ import { RowManager } from './row-manager';
 import type { Styles } from './styles';
 import { SheetViewModel } from './view-model';
 /**
- * Worksheet instance represents a single sheet in a workbook.
+ * The model of a Worksheet.
  */
 export declare class Worksheet {
     private readonly _styles;
-    protected _initialized: boolean;
     protected _sheetId: string;
     protected _snapshot: IWorksheetData;
     protected _cellData: ObjectMatrix<ICellData>;
@@ -83,13 +82,6 @@ export declare class Worksheet {
      */
     clone(): Worksheet;
     getMergeData(): IRange[];
-    /**
-     * @deprecated use `getMergedCell` instead
-     * @param row
-     * @param col
-     * @returns
-     */
-    getMergedCells(row: number, col: number): Nullable<IRange[]>;
     getMergedCell(row: number, col: number): Nullable<IRange>;
     getCell(row: number, col: number): Nullable<ICellDataForSheetInterceptor>;
     getCellRaw(row: number, col: number): Nullable<ICellData>;
@@ -192,4 +184,32 @@ export declare class Worksheet {
      */
     getLastColumnWithContent(): number;
     cellHasValue(value: ICellData): boolean;
+    /**
+     * Iterate a range row by row.
+     *
+     * Performance intensive.
+     */
+    iterateByRow(range: IRange): Iterator<Readonly<ICell>, Readonly<ICell>>;
+    /**
+     * Iterate a range column by column. This is pretty similar to `iterateByRow` but with different order.
+     *
+     * Performance intensive.
+     */
+    iterateByColumn(range: IRange): Iterator<Readonly<ICell>, Readonly<ICell>>;
 }
+/**
+ * A cell info including its span (if it is the top-left cell of a merged cell).
+ */
+export interface ICell {
+    row: number;
+    col: number;
+    rowSpan?: number;
+    colSpan?: number;
+    value: ICellData;
+}
+/**
+ * Get pure text in a cell.
+ * @param cell
+ * @returns pure text in this cell
+ */
+export declare function extractPureTextFromCell(cell: ICellData): Nullable<string>;

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

@@ -37,7 +37,13 @@ export interface ICellData {
      */
     v?: Nullable<CellValue>;
     t?: Nullable<CellValueType>;
+    /**
+     * Raw formula string. For example `=SUM(A1:B4)`.
+     */
     f?: Nullable<string>;
+    /**
+     * Id of the formula.
+     */
     si?: Nullable<string>;
 }
 export interface ICellDataForSheetInterceptor extends ICellData {

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

@@ -21,9 +21,9 @@ export interface IColumnData {
     /**
      * width
      */
-    w: number;
+    w?: number;
     /**
      * hidden
      */
-    hd: BooleanNumber;
+    hd?: BooleanNumber;
 }

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { ISize } from '../../services/floating-object/floating-object-interfaces';
-import type { BooleanNumber, HorizontalAlign, LocaleType, TextDirection, VerticalAlign, WrapStrategy } from '../enum';
+import type { BooleanNumber, CellValueType, HorizontalAlign, LocaleType, TextDirection, VerticalAlign, WrapStrategy } from '../enum';
 import type { IExtraModelData } from './i-extra-model-data';
 import type { IColorStyle, IStyleBase } from './i-style-data';
 /**
@@ -77,7 +77,7 @@ export interface IDocStyles {
 }
 /**
  * Properties of document body
- * 三种更新类型，范围叠加、范围互斥、占位符
+ * Contain three update types: range overlay, range mutual exclusion, and placeholder
  * \v COLUMN_BREAK
  * \f PAGE_BREAK
  * \0 DOCS_END
@@ -296,6 +296,7 @@ export interface IDocumentRenderConfig {
     isRotateNonEastAsian?: BooleanNumber;
     background?: IColorStyle;
     wrapStrategy?: WrapStrategy;
+    cellValueType?: CellValueType;
 }
 export interface ISectionBreakBase {
     columnProperties?: ISectionColumnProperties[];

package/lib/types/types/interfaces/i-range.d.ts

@@ -86,6 +86,11 @@ export interface IGridRange {
     sheetId: string;
     range: IRange;
 }
+export interface IUnitRangeName {
+    unitId: string;
+    sheetName: string;
+    range: IRange;
+}
 /**
  * Range data of Unit
  */

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

@@ -21,7 +21,7 @@ export interface IRowData {
     /**
      * height in pixel
      */
-    h: number;
+    h?: number;
     /**
      * is current row self-adaptive to its content, use `ah` to set row height when true, else use `h`.
      */
@@ -33,5 +33,5 @@ export interface IRowData {
     /**
      * hidden
      */
-    hd: BooleanNumber;
+    hd?: BooleanNumber;
 }

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

@@ -38,7 +38,13 @@ export interface ISelectionCellWithCoord 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>;
 }
 export interface ISelectionWithCoord {