@univerjs/core 0.1.0-beta.0 → 0.1.0-beta.2

package/lib/types/docs/data-model/document-data-model.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { Nullable } from '../../shared';
 import type { IDocumentBody, IDocumentData, IDocumentRenderConfig } from '../../types/interfaces/i-document-data';
 import { type IPaddingData } from '../../types/interfaces/i-style-data';
 import { type DocMutationParams } from './mutation-types';
@@ -62,6 +63,7 @@ export declare class DocumentDataModel extends DocumentDataModelSimple {
     getSelfOrHeaderFooterModel(segmentId?: string): DocumentDataModel;
     getUnitId(): string;
     apply(mutations: DocMutationParams[]): DocMutationParams[];
+    sliceBody(startOffset: number, endOffset: number): Nullable<IDocumentBody>;
     private _updateApply;
     private _deleteApply;
     private _insertApply;

package/lib/types/index.d.ts

@@ -43,11 +43,13 @@ export { IResourceManagerService, ISnapshotPersistenceService } from './services
 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 * from './shared';
+export { deserializeRangeForR1C1 } from './sheets/r1c1-reference';
 export type { IComposeInterceptors, IInterceptor, InterceptorHandler } from './common/interceptor';
 export { composeInterceptors, createInterceptorKey, InterceptorManager } from './common/interceptor';
+export { normalizeTextRuns } from './docs/data-model/apply-utils/common';
 export type { PluginCtor } from './plugin/plugin';
 export { Range } from './sheets/range';
-export { deserializeRangeWithSheet, getAbsoluteRefTypeWithSingleString, getAbsoluteRefTypeWitString, serializeRange, serializeRangeToRefString, serializeRangeWithSheet, serializeRangeWithSpreadsheet, } from './sheets/reference';
+export { deserializeRangeWithSheet, getAbsoluteRefTypeWithSingleString, getAbsoluteRefTypeWitString, type IAbsoluteRefTypeForRange, serializeRange, serializeRangeToRefString, serializeRangeWithSheet, serializeRangeWithSpreadsheet, UNIT_NAME_REGEX, } from './sheets/reference';
 export { Styles } from './sheets/styles';
 export { SheetViewModel } from './sheets/view-model';
 export { getWorksheetUID, Workbook } from './sheets/workbook';

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

@@ -104,7 +104,7 @@ export interface IExecutionOptions {
 export type CommandListener = (commandInfo: Readonly<ICommandInfo>, options?: IExecutionOptions) => void;
 export interface ICommandService {
     registerCommand(command: ICommand): IDisposable;
-    registerAsMultipleCommand(command: ICommand): IDisposable;
+    registerMultipleCommand(command: ICommand): IDisposable;
     executeCommand<P extends object = object, R = boolean>(id: string, params?: P, options?: IExecutionOptions): Promise<R>;
     syncExecuteCommand<P extends object = object, R = boolean>(id: string, params?: P, options?: IExecutionOptions): R;
     /**
@@ -118,18 +118,26 @@ export interface ICommandService {
     beforeCommandExecuted(listener: CommandListener): IDisposable;
 }
 export declare const ICommandService: import("@wendellhu/redi").IdentifierDecorator<ICommandService>;
+/**
+ * The registry of commands.
+ */
+export declare class CommandRegistry {
+    private readonly _commands;
+    registerCommand(command: ICommand): IDisposable;
+    getCommand(id: string): [ICommand] | null;
+}
 export declare class CommandService implements ICommandService {
     private readonly _injector;
-    private readonly _log;
+    private readonly _logService;
     private readonly _commandRegistry;
     private readonly _beforeCommandExecutionListeners;
     private readonly _commandExecutedListeners;
     private _multiCommandDisposables;
     private _commandExecutingLevel;
     private _commandExecutionStack;
-    constructor(_injector: Injector, _log: ILogService);
+    constructor(_injector: Injector, _logService: ILogService);
     registerCommand(command: ICommand): IDisposable;
-    registerAsMultipleCommand(command: ICommand): IDisposable;
+    registerMultipleCommand(command: ICommand): IDisposable;
     beforeCommandExecuted(listener: CommandListener): IDisposable;
     onCommandExecuted(listener: (commandInfo: ICommandInfo) => void): IDisposable;
     executeCommand<P extends object = object, R = boolean>(id: string, params?: P, options?: IExecutionOptions): Promise<R>;

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

@@ -21,12 +21,12 @@ export declare const IConfigService: import("@wendellhu/redi").IdentifierDecorat
 export interface IConfigService {
     getConfig<T>(id: string, defaultValue: T): T;
     getConfig<T>(id: string): Nullable<T>;
-    setConfig(id: string, value: any): void;
+    setConfig(id: string, value: unknown): void;
     deleteConfig(id: string): void;
 }
 export declare class ConfigService implements IConfigService {
     private readonly _config;
     getConfig<T>(id: string): Nullable<T>;
-    setConfig(id: string, value: any): void;
+    setConfig(id: string, value: unknown): void;
     deleteConfig(id: string): void;
 }

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

@@ -16,7 +16,7 @@
 import type { Observable } from 'rxjs';
 import { Disposable } from '../../shared/lifecycle';
 export interface IContextService {
-    contextChanged$: Observable<void>;
+    readonly contextChanged$: Observable<void>;
     getContextValue(key: string): boolean;
     setContextValue(key: string, value: boolean): void;
 }

package/lib/types/services/floating-object/floating-object-manager.service.d.ts

@@ -20,7 +20,7 @@ import type { ITransformState } from './floating-object-interfaces';
 export declare const DEFAULT_DOCUMENT_SUB_COMPONENT_ID = "__default_document_sub_component_id20231101__";
 export interface IFloatingObjectManagerSearchParam {
     unitId: string;
-    subComponentId: string;
+    subUnitId: string;
 }
 export interface IFloatingObjectManagerSearchItemParam extends IFloatingObjectManagerSearchParam {
     floatingObjectId: string;

package/lib/types/services/{auth/auth.service.d.ts → lifecycle/__tests__/lifecycle.service.spec.d.ts}

@@ -13,5 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface IAuthService {
-}
+export {};

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

@@ -18,15 +18,33 @@ import { Observable } from 'rxjs';
 import { Disposable } from '../../shared/lifecycle';
 import { ILogService } from '../log/log.service';
 import { LifecycleStages } from './lifecycle';
+/**
+ * This service controls the lifecycle of a Univer instance. Other modules can
+ * inject this service to read the current lifecycle stage or subscribe to
+ * lifecycle changes.
+ */
 export declare class LifecycleService extends Disposable {
     private readonly _logService;
     private _lifecycle$;
-    lifecycle$: Observable<LifecycleStages>;
+    readonly lifecycle$: Observable<LifecycleStages>;
     constructor(_logService: ILogService);
     get stage(): LifecycleStages;
     set stage(stage: LifecycleStages);
+    dispose(): void;
+    /**
+     * Subscribe to lifecycle changes and all previous stages and the current
+     * stage will be emitted immediately.
+     * @returns
+     */
     subscribeWithPrevious(): Observable<LifecycleStages>;
+    private _reportProgress;
 }
+/**
+ * This service is used to initialize modules on a certain lifecycle stage.
+ * Refer to `runOnLifecycle` and `OnLifecycle` for more details.
+ *
+ * @internal
+ */
 export declare class LifecycleInitializerService extends Disposable {
     private _lifecycleService;
     private readonly _injector;

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

@@ -18,10 +18,12 @@ export declare enum LogLevel {
     SILENT = 0,
     ERROR = 1,
     WARN = 2,
-    VERBOSE = 3
+    INFO = 3,
+    VERBOSE = 4
 }
 type ArgsType = any[];
 export interface ILogService {
+    debug(...args: ArgsType): void;
     log(...args: ArgsType): void;
     warn(...args: ArgsType): void;
     error(...args: ArgsType): void;
@@ -30,9 +32,11 @@ export interface ILogService {
 export declare const ILogService: import("@wendellhu/redi").IdentifierDecorator<ILogService>;
 export declare class DesktopLogService extends Disposable implements ILogService {
     private _logLevel;
+    debug(...args: ArgsType): void;
     log(...args: ArgsType): void;
     warn(...args: ArgsType): void;
     error(...args: ArgsType): void;
     setLogLevel(logLevel: LogLevel): void;
+    private _log;
 }
 export {};

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

@@ -33,7 +33,7 @@ export declare class DisposableCollection implements IDisposable {
 export declare class Disposable implements IDisposable {
     protected _disposed: boolean;
     private readonly _collection;
-    protected disposeWithMe(disposable: IDisposable): IDisposable;
+    protected disposeWithMe(disposable: IDisposable | SubscriptionLike): IDisposable;
     dispose(): void;
 }
 export declare class RxDisposable extends Disposable implements IDisposable {

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

@@ -27,8 +27,8 @@ 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>): void;
-export declare function concatMatrixArray<T>(source: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>, target: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>): IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>;
-export declare function sliceMatrixArray<T>(start: number, end: number, matrixArray: IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>): IObjectArrayPrimitiveType<T> | IObjectMatrixPrimitiveType<T>;
+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;
 /**
  * A two-dimensional array represented by a two-level deep object and provides an array-like API

package/lib/types/{types/const/doc-action-names.d.ts → sheets/__tests__/r1c1-reference.spec.d.ts}

@@ -13,9 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare enum DOC_ACTION_NAMES {
-    INSERT_ACTION_NAME = "InsertAction",
-    DELETE_ACTION_NAME = "DeleteAction",
-    RETAIN_ACTION_NAME = "RetainAction",
-    UPDATE_DOCUMENT_ACTION_NAME = "UpdateDocumentAction"
-}
+export {};

package/lib/types/sheets/__tests__/reference.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/__tests__/workbook.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/r1c1-reference.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.
+ */
+import type { IGridRangeName } from './reference';
+export declare function deserializeRangeForR1C1(refString: string, currentRow?: number, currentColumn?: number): IGridRangeName;

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

@@ -15,11 +15,16 @@
  */
 import type { IRange } from '../types/interfaces/i-range';
 import { AbsoluteRefType } from '../types/interfaces/i-range';
+export declare const UNIT_NAME_REGEX = "'?\\[((?![\\/?:\"<>|*\\\\]).)*?\\]";
 export interface IGridRangeName {
     unitId: string;
     sheetName: string;
     range: IRange;
 }
+export interface IAbsoluteRefTypeForRange {
+    startAbsoluteRefType: AbsoluteRefType;
+    endAbsoluteRefType?: AbsoluteRefType;
+}
 /**
  *
  * @param singleRefString for example A1 or B10,  not A1:B10
@@ -29,13 +34,7 @@ export declare function getAbsoluteRefTypeWithSingleString(singleRefString: stri
  *
  * @param refString for example A1:B10
  */
-export declare function getAbsoluteRefTypeWitString(refString: string): {
-    startAbsoluteRefType: AbsoluteRefType;
-    endAbsoluteRefType: AbsoluteRefType;
-} | {
-    startAbsoluteRefType: AbsoluteRefType;
-    endAbsoluteRefType?: undefined;
-};
+export declare function getAbsoluteRefTypeWitString(refString: string): IAbsoluteRefTypeForRange;
 /**
  * Serialize an `IRange` into a string.
  * @param range The `IRange` to be serialized
@@ -57,4 +56,9 @@ export declare function serializeRangeWithSheet(sheetName: string, range: IRange
  */
 export declare function serializeRangeWithSpreadsheet(unit: string, sheetName: string, range: IRange): string;
 export declare function serializeRangeToRefString(gridRangeName: IGridRangeName): string;
+export declare function handleRefStringInfo(refString: string): {
+    refBody: string;
+    sheetName: string;
+    unitId: string;
+};
 export declare function deserializeRangeWithSheet(refString: string): IGridRangeName;

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

@@ -48,11 +48,13 @@ export declare class Workbook extends Disposable {
     private _snapshot;
     private _unitId;
     private _count;
+    get name(): string;
     constructor(workbookData: Partial<IWorkbookData> | undefined, _log: ILogService);
     dispose(): void;
     save(): IWorkbookData;
     static isIRangeType(range: IRangeType | IRangeType[]): Boolean;
     getSnapshot(): IWorkbookData;
+    getName(): string;
     getUnitId(): string;
     getRev(): number;
     incrementRev(): void;
@@ -126,8 +128,24 @@ export declare class Workbook extends Disposable {
      */
     transformRangeType(range: IRangeType | IRangeType[]): IGridRange;
     load(config: IWorkbookData): void;
+    /**
+     * Check if sheet name is unique
+     * @param name sheet name
+     * @returns True if sheet name is unique
+     */
     checkSheetName(name: string): boolean;
+    /**
+     *  Check whether the sheet name is unique and generate a new unique sheet name
+     * @param name sheet name
+     * @returns Unique sheet name
+     */
     uniqueSheetName(name?: string): string;
+    /**
+     * Automatically generate new sheet name
+     * @param name sheet name
+     * @returns New sheet name
+     */
+    generateNewSheetName(name: string): string;
     /**
      * Get the range array based on the range string and sheet id
      *

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

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './action-names';
 export * from './const';
 export * from './extension-names';
 export * from './theme-color-map';

package/lib/types/types/interfaces/__tests__/i-cell-data.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/types/interfaces/i-cell-data.d.ts

@@ -47,3 +47,4 @@ export interface ICellDataForSheetInterceptor extends ICellData {
 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 | ICellV>): boolean;

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

@@ -22,6 +22,7 @@ import type { ThemeColorType } from '../enum/theme-color-type';
  */
 export interface ITextDecoration {
     s: BooleanNumber;
+    c?: BooleanNumber;
     cl?: IColorStyle;
     t?: TextDecoration;
 }

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

@@ -22,12 +22,21 @@ import type { IWorksheetData } from './i-worksheet-data';
  * Properties of a workbook's configuration
  */
 export interface IWorkbookData extends IExtraModelData {
-    /** unit id */
+    /**
+     * unit id
+     */
     id: string;
-    /** Revision of this document. Would be used in collaborated editing. Starts from one. */
+    /**
+     * Revision of this spreadsheet. Would be used in collaborated editing. Starts from one.
+     */
     rev?: number;
+    /**
+     * Name of the spreadsheet.
+     */
     name: string;
-    /** Version of Univer model definition. */
+    /**
+     * Version of Univer model definition.
+     */
     appVersion: string;
     locale: LocaleType;
     /** Style reference. */