@univerjs/core 0.1.0-beta.4 → 0.1.0-beta.5

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

@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare class Registry {
+export declare class Registry<T = any> {
     private _data;
-    static create(): Registry;
-    add(dataInstance: any): void;
-    delete(dataInstance: any): void;
-    getData(): any[];
+    static create<T = any>(): Registry<T>;
+    add(dataInstance: T): void;
+    delete(dataInstance: T): void;
+    getData(): T[];
 }
 /**
  * Add extension modules statically when the plugin is initialized, so that the plugin can register these extension modules uniformly

package/lib/types/index.d.ts

@@ -45,7 +45,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, } from './services/undoredo/undoredo.service';
+export { type IUndoRedoCommandInfos, type IUndoRedoItem, IUndoRedoService, type IUndoRedoStatus, LocalUndoRedoService, RedoCommand, UndoCommand, RedoCommandId, UndoCommandId, } from './services/undoredo/undoredo.service';
 export * from './shared';
 export type { IComposeInterceptors, IInterceptor, InterceptorHandler } from './common/interceptor';
 export { composeInterceptors, createInterceptorKey, InterceptorManager } from './common/interceptor';
@@ -53,6 +53,7 @@ export { normalizeTextRuns } from './docs/data-model/apply-utils/common';
 export type { PluginCtor } from './plugin/plugin';
 export { Range } from './sheets/range';
 export { Styles } from './sheets/styles';
+export { DEFAULT_WORKSHEET_COLUMN_COUNT, DEFAULT_WORKSHEET_COLUMN_COUNT_KEY, DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT_KEY, DEFAULT_WORKSHEET_COLUMN_WIDTH_KEY, DEFAULT_WORKSHEET_ROW_COUNT_KEY, DEFAULT_WORKSHEET_ROW_HEIGHT_KEY, DEFAULT_WORKSHEET_ROW_TITLE_WIDTH_KEY, DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT, DEFAULT_WORKSHEET_COLUMN_WIDTH, DEFAULT_WORKSHEET_ROW_COUNT, DEFAULT_WORKSHEET_ROW_HEIGHT, DEFAULT_WORKSHEET_ROW_TITLE_WIDTH, mergeWorksheetSnapshotWithDefault, } from './sheets/sheet-snapshot-utils';
 export { SheetViewModel } from './sheets/view-model';
 export { getWorksheetUID, Workbook } from './sheets/workbook';
 export { Worksheet } from './sheets/worksheet';

package/lib/types/services/locale/__tests__/locale.service.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/services/locale/locale.service.d.ts

@@ -15,7 +15,7 @@
  */
 import { Subject } from 'rxjs';
 import { Disposable } from '../../shared/lifecycle';
-import type { ILocales } from '../../shared/locale';
+import type { ILanguagePack, ILocales } from '../../shared/locale';
 import { LocaleType } from '../../types/enum/locale-type';
 /**
  * This service provides i18n and timezone / location features to other modules.
@@ -29,12 +29,33 @@ export declare class LocaleService extends Disposable {
      * Load more locales after init
      *
      * @param locales - Locale object
-     * @returns void
      *
      */
     load(locales: ILocales): void;
-    t: (key: string) => string;
+    /**
+     * Translate a key to the current locale
+     * @param {string} key the key to translate
+     * @param {string[]} args optional arguments to replace in the translated string
+     * @returns {string} the translated string
+     * @example
+     * const locales = {
+     *   [LocaleType.EN_US]: {
+     *     foo: {
+     *       bar: 'Hello'
+     *    }
+     * }
+     * t('foo.bar') => 'Hello'
+     *
+     * @example
+     * const locales = {
+     *   [LocaleType.EN_US]: {
+     *     foo: {
+     *       bar: 'Hello {0}'
+     *    }
+     * }
+     * t('foo.bar', 'World') => 'Hello World'
+     */
+    t: (key: string, ...args: string[]) => string;
     setLocale(locale: LocaleType): void;
-    getLocales(): import("../../shared/locale").ILanguagePack | undefined;
-    getCurrentLocale(): LocaleType;
+    getLocales(): ILanguagePack | undefined;
 }

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

@@ -47,6 +47,22 @@ export interface IUndoRedoStatus {
     undos: number;
     redos: number;
 }
+export declare const RedoCommandId = "univer.command.redo";
+export declare const UndoCommandId = "univer.command.undo";
+export declare const UndoCommand: {
+    readonly type: CommandType.COMMAND;
+    readonly id: "univer.command.undo";
+    handler(accessor: IAccessor): Promise<boolean>;
+    dispose(): void;
+    dispatchToHandlers(): Promise<boolean>;
+};
+export declare const RedoCommand: {
+    readonly type: CommandType.COMMAND;
+    readonly id: "univer.command.redo";
+    handler(accessor: IAccessor): Promise<boolean>;
+    dispose(): void;
+    dispatchToHandlers(): Promise<boolean>;
+};
 /**
  * This UndoRedoService is local.
  */
@@ -77,17 +93,3 @@ export declare class LocalUndoRedoService extends Disposable implements IUndoRed
     protected _getRedoStackForFocused(): IUndoRedoItem[];
     private _getFocusedUniverInstanceId;
 }
-export declare const UndoCommand: {
-    readonly type: CommandType.COMMAND;
-    readonly id: "univer.command.undo";
-    handler(accessor: IAccessor): Promise<boolean>;
-    dispose(): void;
-    dispatchToHandlers(): Promise<boolean>;
-};
-export declare const RedoCommand: {
-    readonly type: CommandType.COMMAND;
-    readonly id: "univer.command.redo";
-    handler(accessor: IAccessor): Promise<boolean>;
-    dispose(): void;
-    dispatchToHandlers(): Promise<boolean>;
-};

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

@@ -200,7 +200,7 @@ export declare class Range {
     /**
      * Returns the font weights of the cells in the range.
      */
-    private getFontWeights;
+    private _getFontWeights;
     /**
      * Returns the grid ID of the range's parent sheet.
      */

package/lib/types/sheets/sheet-snapshot-utils.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.
+ */
+import type { IWorksheetData } from '../types/interfaces/i-worksheet-data';
+export declare const DEFAULT_WORKSHEET_ROW_COUNT_KEY = "DEFAULT_WORKSHEET_ROW_COUNT";
+export declare const DEFAULT_WORKSHEET_ROW_COUNT = 1000;
+export declare const DEFAULT_WORKSHEET_COLUMN_COUNT_KEY = "DEFAULT_WORKSHEET_COLUMN_COUNT";
+export declare const DEFAULT_WORKSHEET_COLUMN_COUNT = 20;
+export declare const DEFAULT_WORKSHEET_ROW_HEIGHT_KEY = "DEFAULT_WORKSHEET_ROW_HEIGHT";
+export declare const DEFAULT_WORKSHEET_ROW_HEIGHT = 19;
+export declare const DEFAULT_WORKSHEET_COLUMN_WIDTH_KEY = "DEFAULT_WORKSHEET_COLUMN_WIDTH";
+export declare const DEFAULT_WORKSHEET_COLUMN_WIDTH = 73;
+export declare const DEFAULT_WORKSHEET_ROW_TITLE_WIDTH_KEY = "DEFAULT_WORKSHEET_ROW_TITLE_WIDTH";
+export declare const DEFAULT_WORKSHEET_ROW_TITLE_WIDTH = 46;
+export declare const DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT_KEY = "DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT";
+export declare const DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT = 20;
+/**
+ * This function is used to merge the user passed in snapshot with the default snapshot
+ * without changing the user's snapshot's reference.
+ *
+ * @param snapshot user passed in snapshot
+ * @returns merged snapshot
+ */
+export declare function mergeWorksheetSnapshotWithDefault(snapshot: Partial<IWorksheetData>): IWorksheetData;

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

@@ -24,12 +24,13 @@ export declare function getWorksheetUID(workbook: Workbook, worksheet: Worksheet
  * Access and create Univer Sheets files
  */
 export declare class Workbook extends Disposable {
-    private readonly _log;
+    private readonly _logService;
     private readonly _sheetCreated$;
     readonly sheetCreated$: import("rxjs").Observable<Worksheet>;
     private readonly _sheetDisposed$;
     readonly sheetDisposed$: import("rxjs").Observable<Worksheet>;
     private readonly _activeSheet$;
+    private get _activeSheet();
     readonly activeSheet$: import("rxjs").Observable<Nullable<Worksheet>>;
     /**
      * sheets list
@@ -49,10 +50,10 @@ export declare class Workbook extends Disposable {
     private _unitId;
     private _count;
     get name(): string;
-    constructor(workbookData: Partial<IWorkbookData> | undefined, _log: ILogService);
+    constructor(workbookData: Partial<IWorkbookData> | undefined, _logService: ILogService);
     dispose(): void;
     save(): IWorkbookData;
-    static isIRangeType(range: IRangeType | IRangeType[]): Boolean;
+    static isIRangeType(range: IRangeType | IRangeType[]): boolean;
     getSnapshot(): IWorkbookData;
     getName(): string;
     getUnitId(): string;
@@ -70,17 +71,20 @@ export declare class Workbook extends Disposable {
     getStyles(): Styles;
     getConfig(): IWorkbookData;
     getIndexBySheetId(sheetId: string): number;
-    getRawActiveSheet(): Nullable<string>;
-    getActiveSheet(): Worksheet;
-    __setActiveSheet(worksheet: Worksheet): void;
-    getActiveSheetIndex(): number;
-    getSheetSize(): number;
     /**
-     * Applies all pending Sheets changes.
      *
-     * @returns void
+     * @returns
      */
-    flush(): void;
+    getRawActiveSheet(): Nullable<Worksheet>;
+    /**
+     * Get the active sheet. If there is no active sheet, the first sheet would
+     * be set active.
+     */
+    getActiveSheet(): Worksheet;
+    setActiveSheet(worksheet: Nullable<Worksheet>): void;
+    removeSheet(sheetId: string): boolean;
+    getActiveSheetIndex(): number;
+    getSheetSize(): number;
     getSheets(): Worksheet[];
     getSheetsName(): string[];
     getSheetIndex(sheet: Worksheet): number;
@@ -156,5 +160,5 @@ export declare class Workbook extends Disposable {
     /**
      * Get Default Sheet
      */
-    private _getDefaultWorkSheet;
+    private _passWorksheetSnapshots;
 }

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

@@ -15,8 +15,7 @@
  */
 import type { Nullable } from '../shared';
 import { ObjectMatrix } from '../shared';
-import type { SheetTypes } from '../types/enum';
-import { BooleanNumber } from '../types/enum';
+import type { BooleanNumber } from '../types/enum';
 import type { ICellData, ICellDataForSheetInterceptor, IFreeze, IRange, IWorksheetData } from '../types/interfaces';
 import { ColumnManager } from './column-manager';
 import { Range } from './range';
@@ -47,6 +46,16 @@ export declare class Worksheet {
      * @returns
      */
     getCellMatrix(): ObjectMatrix<Nullable<ICellData>>;
+    /**
+     * Get worksheet printable cell range.
+     * @returns
+     */
+    getCellMatrixPrintRange(): {
+        startColumn: number;
+        startRow: number;
+        endColumn: number;
+        endRow: number;
+    } | null;
     /**
      * Returns Row Manager
      * @returns Row Manager
@@ -97,11 +106,6 @@ export declare class Worksheet {
     getRange(range: IRange): Range;
     getRange(startRow: number, startColumn: number): Range;
     getRange(startRow: number, startColumn: number, endRow: number, endColumn: number): Range;
-    /**
-     * Returns WorkSheet Status
-     * @returns WorkSheet Status
-     */
-    getStatus(): BooleanNumber;
     /**
      * Return WorkSheetZoomRatio
      * @return zoomRatio
@@ -127,11 +131,6 @@ export declare class Worksheet {
      * @returns the current number of rows in the sheet, regardless of content
      */
     getMaxRows(): number;
-    /**
-     * Returns the type of the sheet.
-     * @returns the type of the sheet
-     */
-    getType(): SheetTypes;
     getRowCount(): number;
     setRowCount(count: number): void;
     getColumnCount(): number;
@@ -145,7 +144,7 @@ export declare class Worksheet {
      * Returns true if the sheet's gridlines are hidden; otherwise returns false. Gridlines are visible by default.
      * @returns Gridlines Hidden Status
      */
-    hasHiddenGridlines(): Boolean;
+    hasHiddenGridlines(): boolean;
     /**
      * Gets the sheet tab color, or null if the sheet tab has no color.
      * @returns the sheet tab color or null
@@ -182,19 +181,6 @@ export declare class Worksheet {
      * @returns true if this sheet layout is right-to-left. Returns false if the sheet uses the default left-to-right layout.
      */
     isRightToLeft(): BooleanNumber;
-    /**
-     * @typeParam T - plugin data structure
-     * @param name - plugin name
-     * @returns information stored by the plugin
-     */
-    getPluginMeta<T>(name: string): T;
-    /**
-     * @typeParam T - plugin data structure
-     * @param name - plugin name
-     * @param value - plugin value
-     * @returns
-     */
-    setPluginMeta<T>(name: string, value: T): void;
     /**
      * Returns the position of the last row that has content.
      * @returns the position of the last row that has content.

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { BooleanNumber, HorizontalAlign, TextDirection, VerticalAlign, WrapStrategy } from '../enum';
-import type { IWorkbookData, IWorksheetData } from '../interfaces';
+import type { IWorkbookData } from '../interfaces';
 /**
  * Used as an illegal range array return value
  */
@@ -56,18 +56,8 @@ export declare const DEFAULT_CELL: {
  * Used as an init workbook return value
  */
 export declare const DEFAULT_WORKBOOK: IWorkbookData;
-export declare const DEFAULT_WORKSHEET_ROW_COUNT = 1000;
-export declare const DEFAULT_WORKSHEET_COLUMN_COUNT = 20;
-export declare const DEFAULT_WORKSHEET_ROW_HEIGHT = 19;
-export declare const DEFAULT_WORKSHEET_COLUMN_WIDTH = 73;
-export declare const DEFAULT_WORKSHEET_ROW_TITLE_WIDTH = 46;
-export declare const DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT = 20;
 /**
- * Used as an init worksheet return value
- */
-export declare const DEFAULT_WORKSHEET: IWorksheetData;
-/**
- * Default styles
+ * Default styles.
  */
 export declare const DEFAULT_STYLES: {
     /**
@@ -119,7 +109,7 @@ export declare const DEFAULT_STYLES: {
          */
         v: BooleanNumber;
     };
-    /** *
+    /**
      * textDirection
      */
     td: TextDirection;

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

@@ -30,6 +30,11 @@ export interface IDocumentData extends IReferenceSource, IExtraModelData {
     body?: IDocumentBody;
     documentStyle: IDocumentStyle;
     settings?: IDocumentSettings;
+    resources?: Array<{
+        id?: string;
+        name: string;
+        data: string;
+    }>;
 }
 export interface IReferenceSource {
     footers?: IFooters;

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

@@ -159,7 +159,7 @@ export interface IStyleData extends IStyleBase {
      * textRotation
      */
     tr?: Nullable<ITextRotation>;
-    /** *
+    /**
      * textDirection
      */
     td?: Nullable<TextDirection>;

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

@@ -14,27 +14,25 @@
  * limitations under the License.
  */
 import type { IObjectArrayPrimitiveType, IObjectMatrixPrimitiveType } from '../../shared/object-matrix';
-import type { IKeyValue } from '../../shared/types';
-import type { BooleanNumber, SheetTypes } from '../enum';
+import type { BooleanNumber } from '../enum';
 import type { ICellData } from './i-cell-data';
 import type { IColumnData } from './i-column-data';
 import type { IFreeze } from './i-freeze';
 import type { IRange, IRangeType } from './i-range';
 import type { IRowData } from './i-row-data';
 /**
- * Properties of a worksheet's configuration
- *
- * TODO: 考虑将非通用配置，抽离到插件
- *
- * 比如 showGridlines 是sheet特有的，而如果实现如普通表格，就不需要 showGridlines
+ * Snapshot of a worksheet.
  */
 export interface IWorksheetData {
-    type: SheetTypes;
+    /**
+     * 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
+     * Determine whether the sheet is hidden.
      *
      * @remarks
      * See {@link BooleanNumber| the BooleanNumber enum} for more details.
@@ -43,9 +41,6 @@ export interface IWorksheetData {
      */
     hidden: BooleanNumber;
     freeze: IFreeze;
-    /**
-     * row and column  count in worksheet, not like excel, it is unlimited
-     */
     rowCount: number;
     columnCount: number;
     zoomRatio: number;
@@ -53,18 +48,12 @@ export interface IWorksheetData {
     scrollLeft: number;
     defaultColumnWidth: number;
     defaultRowHeight: number;
+    /** All merged cells in this worksheet. */
     mergeData: IRange[];
-    hideRow: [];
-    hideColumn: [];
-    /**
-     * If the worksheet is the active one.
-     * @deprecated this should be removed
-     */
-    status: BooleanNumber;
+    /** A matrix storing cell contents by row and column index. */
     cellData: IObjectMatrixPrimitiveType<ICellData>;
     rowData: IObjectArrayPrimitiveType<Partial<IRowData>>;
     columnData: IObjectArrayPrimitiveType<Partial<IColumnData>>;
-    showGridlines: BooleanNumber;
     rowHeader: {
         width: number;
         hidden?: BooleanNumber;
@@ -73,7 +62,8 @@ export interface IWorksheetData {
         height: number;
         hidden?: BooleanNumber;
     };
+    showGridlines: BooleanNumber;
+    /** @deprecated */
     selections: IRangeType[];
     rightToLeft: BooleanNumber;
-    pluginMeta: IKeyValue;
 }