@univerjs/core 0.1.2 → 0.1.4

package/lib/types/shared/coder.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.
+ */
+export declare function b64EncodeUnicode(str: string): string;
+export declare function b64DecodeUnicode(str: string): string;

package/lib/types/shared/color/color-kit.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-interface IRgbColor {
+export interface IRgbColor {
     b: number;
     g: number;
     r: number;
@@ -61,4 +61,6 @@ export declare class ColorKit {
     isLight(): boolean;
     private _setNullColor;
 }
+export declare function isBlackColor(color: string): boolean;
+export declare function isWhiteColor(color: string): boolean;
 export {};

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

@@ -19,4 +19,5 @@ interface AnyObject {
 }
 export declare function deepCompare(arg1: AnyObject, arg2: AnyObject): boolean;
 export declare function isSameStyleTextRun(tr1: ITextRun, tr2: ITextRun): boolean;
+export declare function checkForSubstrings(searchString: string, substrings: string[]): boolean;
 export {};

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

@@ -16,7 +16,7 @@
 export * from './array-search';
 export * from './blob';
 export * from './color/color';
-export { ColorKit, COLORS, RGB_PAREN, RGBA_PAREN } from './color/color-kit';
+export { ColorKit, COLORS, RGB_PAREN, RGBA_PAREN, type IRgbColor } from './color/color-kit';
 export * from './command-enum';
 export * from './common';
 export * from './compare';

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

@@ -13,8 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export type LanguageValue = string | string[] | ILanguagePack | ILanguagePack[] | boolean;
 export interface ILanguagePack {
-    [key: string]: string | ILanguagePack | ILanguagePack[];
+    [key: string]: LanguageValue;
 }
 export interface ILocales {
     [key: string]: ILanguagePack;

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

@@ -42,6 +42,9 @@ export declare class ObjectMatrix<T> {
     getMatrix(): IObjectMatrixPrimitiveType<T>;
     forEach(callback: (row: number, objectArray: IObjectArrayPrimitiveType<T>) => Nullable<boolean>): ObjectMatrix<T>;
     forRow(callback: (row: number, cols: number[]) => Nullable<boolean>): ObjectMatrix<T>;
+    /**
+     * Iterate the object matrix with row priority, which means it scan the whole range row by row.
+     */
     forValue(callback: (row: number, col: number, value: T) => Nullable<boolean>): ObjectMatrix<T>;
     swapRow(src: number, target: number): void;
     getRow(rowIndex: number): Nullable<IObjectArrayPrimitiveType<T>>;

package/lib/types/shared/rxjs.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.
+ */
+import type { IDisposable } from '@wendellhu/redi';
+import { Observable } from 'rxjs';
+type CallbackFn<T extends readonly unknown[]> = (cb: (...args: T) => void) => IDisposable;
+export declare function fromCallback<T extends readonly unknown[]>(callback: CallbackFn<T>): Observable<T>;
+export {};

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

@@ -23,7 +23,7 @@ export declare class Tools {
     static deleteBlank(value?: string): string | undefined;
     static getSystemType(): string;
     static getBrowserType(): string;
-    static generateRandomId(n?: number): string;
+    static generateRandomId(n?: number, alphabet?: string): string;
     static getClassName(instance: object): string;
     static deepMerge(target: any, ...sources: any[]): any;
     static numberFixed(value: number, digit: number): number;

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/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>;
@@ -215,3 +207,9 @@ export interface ICell {
     colSpan?: number;
     value: ICellData;
 }
+/**
+ * Get pure text in a cell.
+ * @param cell
+ * @returns pure text in this cell
+ */
+export declare function extractPureTextFromCell(cell: ICellData): string;

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

@@ -14,10 +14,12 @@
  * limitations under the License.
  */
 import type { ISlideData, ISlidePage } from '../../types/interfaces';
-export declare class Slide {
+export declare class SlideDataModel {
     private _snapshot;
     private _unitId;
     constructor(snapshot: Partial<ISlideData>);
+    getContainer(): string | undefined;
+    getParentRenderUnitId(): string | undefined;
     getSnapshot(): ISlideData;
     getUnitId(): string;
     getPages(): {

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';
 /**
@@ -35,6 +35,7 @@ export interface IDocumentData extends IReferenceSource, IExtraModelData {
         name: string;
         data: string;
     }>;
+    disabled?: boolean;
 }
 export interface IReferenceSource {
     footers?: IFooters;
@@ -296,6 +297,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 {

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

@@ -18,12 +18,13 @@ import type { IKeyType, Nullable } from '../../shared/types';
 import type { LocaleType, ThemeColorType } from '../enum';
 import type { ShapeType } from '../enum/shape-type';
 import type { ICustomBlock, IDocumentData, ILists } from './i-document-data';
+import type { IExtraModelData } from './i-extra-model-data';
 import type { IImageProperties } from './i-image-properties';
 import type { IPlaceholder } from './i-placeholder';
 import type { IShapeProperties } from './i-shape-properties';
 import type { IColorStyle, IStyleBase, IStyleData } from './i-style-data';
 import type { IWorksheetData } from './i-worksheet-data';
-export interface ISlideData extends IReferenceSource {
+export interface ISlideData extends IReferenceSource, IExtraModelData {
     id: string;
     locale?: LocaleType;
     title: string;