@univerjs/core 0.1.2 → 0.1.4

package/lib/types/basics/univer-slide.d.ts

@@ -15,7 +15,7 @@
  */
 import { Injector } from '@wendellhu/redi';
 import { LifecycleInitializerService, LifecycleService } from '../services/lifecycle/lifecycle.service';
-import { Slide } from '../slides/domain/slide-model';
+import { SlideDataModel } from '../slides/domain/slide-model';
 import type { ISlideData } from '../types/interfaces/i-slide-data';
 import { PluginHolder } from './plugin-holder';
 /**
@@ -26,5 +26,5 @@ export declare class UniverSlide extends PluginHolder {
     protected readonly _lifecycleService: LifecycleService;
     protected readonly _lifecycleInitializerService: LifecycleInitializerService;
     constructor(_injector: Injector, _lifecycleService: LifecycleService, _lifecycleInitializerService: LifecycleInitializerService);
-    createSlide(data: Partial<ISlideData>): Slide;
+    createSlide(data: Partial<ISlideData>): SlideDataModel;
 }

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

@@ -18,7 +18,7 @@ import type { DocumentDataModel } from '../docs/data-model/document-data-model';
 import type { Plugin, PluginCtor } from '../plugin/plugin';
 import { LifecycleInitializerService, LifecycleService } from '../services/lifecycle/lifecycle.service';
 import type { Workbook } from '../sheets/workbook';
-import type { Slide } from '../slides/domain/slide-model';
+import type { SlideDataModel } from '../slides/domain/slide-model';
 import type { LocaleType } from '../types/enum/locale-type';
 import type { IDocumentData, ISlideData, IUniverData, IWorkbookData } from '../types/interfaces';
 import { PluginHolder } from './plugin-holder';
@@ -41,7 +41,7 @@ export declare class Univer extends PluginHolder {
      */
     createUniverSheet(config: Partial<IWorkbookData>): Workbook;
     createUniverDoc(config: Partial<IDocumentData>): DocumentDataModel;
-    createUniverSlide(config: Partial<ISlideData>): Slide;
+    createUniverSlide(config: Partial<ISlideData>): SlideDataModel;
     private _initDependencies;
     /**
      * Initialize modules provided by Univer-type plugins.
@@ -49,7 +49,7 @@ export declare class Univer extends PluginHolder {
     private _tryProgressToStart;
     private _tryProgressToReady;
     /** Register a plugin into univer. */
-    registerPlugin<T extends Plugin>(plugin: PluginCtor<T>, config?: any): void;
+    registerPlugin<T extends PluginCtor<Plugin>>(plugin: T, config?: ConstructorParameters<T>[0]): void;
     private _initLazyPluginsTimer?;
     private _scheduleInitPluginAfterStarted;
     private _flushLazyPlugins;

package/lib/types/common/__tests__/array.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/common/array.d.ts

@@ -21,3 +21,11 @@ export declare function remove<T>(arr: T[], item: T): boolean;
  */
 export declare function dedupe<T>(arr: T[]): T[];
 export declare function findLast<T>(arr: T[], callback: (item: T, index: number) => boolean): T | null;
+/**
+ * Rotate an array without mutating the original array.
+ * @param arr the array to be rotated
+ * @param steps how many steps to rotate
+ * @returns the rotated array, it is another array, the original array is not mutated.
+ */
+export declare function rotate<T>(arr: Readonly<T[]>, steps: number): readonly T[];
+export declare function groupBy<T>(arr: Readonly<T[]>, keyFn: (v: T) => string): Map<string, T[]>;

package/lib/types/common/interceptor.d.ts

@@ -24,7 +24,7 @@ export type IComposeInterceptors<T = any, C = any> = (interceptors: Array<IInter
 /**
  * A helper to compose a certain type of interceptors.
  */
-export declare const composeInterceptors: <T, C>(interceptors: IInterceptor<T, C>[]) => (initValue: Nullable<T>, initContext: C) => Nullable<T>;
+export declare const composeInterceptors: <T, C>(interceptors: Array<IInterceptor<T, C>>) => (initValue: Nullable<T>, initContext: C) => Nullable<T>;
 export declare class InterceptorManager<P extends Record<string, IInterceptor<any, any>>> {
     private _interceptorsByName;
     private _interceptorPoints;

package/lib/types/docs/data-model/empty-snapshot.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { LocaleType } from '../../types/enum/locale-type';
+import type { IDocumentData } from '../../types/interfaces';
+export declare function getEmptySnapshot(unitID?: string, locale?: LocaleType, title?: string): IDocumentData;

package/lib/types/index.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export * from './basics';
-export { dedupe, remove } from './common/array';
+export { dedupe, remove, rotate, groupBy } from './common/array';
 export { DEFAULT_EMPTY_DOCUMENT_VALUE, DOCS_FORMULA_BAR_EDITOR_UNIT_ID_KEY, DOCS_NORMAL_EDITOR_UNIT_ID_KEY, } from './common/const';
 export { throttle } from './common/function';
 export { MemoryCursor } from './common/memory-cursor';
@@ -48,6 +48,7 @@ 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, RedoCommandId, UndoCommandId, } from './services/undoredo/undoredo.service';
 export * from './shared';
+export { fromCallback } from './shared/rxjs';
 export type { IComposeInterceptors, IInterceptor, InterceptorHandler } from './common/interceptor';
 export { composeInterceptors, createInterceptorKey, InterceptorManager } from './common/interceptor';
 export { normalizeTextRuns } from './docs/data-model/apply-utils/common';
@@ -57,7 +58,7 @@ 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';
+export { Worksheet, extractPureTextFromCell } from './sheets/worksheet';
 export * from './slides/domain';
 export * from './types/const';
 export * from './types/enum';
@@ -65,3 +66,11 @@ export * from './types/interfaces';
 export { UniverInstanceService } from './services/instance/instance.service';
 export { LifecycleInitializerService } from './services/lifecycle/lifecycle.service';
 export { ConfigService } from './services/config/config.service';
+export { ISnapshotServerService } from './services/snapshot/snapshot-server.service';
+export { transformSnapshotToWorkbookData, transformWorkbookDataToSnapshot, transformDocumentDataToSnapshot, transformSnapshotToDocumentData, generateTemporarySnap, } from './services/snapshot/snapshot-transform';
+export { textEncoder, textDecoder } from './services/snapshot/snapshot-utils';
+export { type ILogContext } from './services/log/context';
+export { b64DecodeUnicode, b64EncodeUnicode } from './shared/coder';
+export { ClientSnapshotServerService } from './services/snapshot/snapshot-server.service';
+export { getSheetBlocksFromSnapshot } from './services/snapshot/snapshot-transform';
+export { isBlackColor, isWhiteColor } from './shared/color/color-kit';

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

@@ -17,7 +17,7 @@ import type { IAccessor, IDisposable } from '@wendellhu/redi';
 import { Injector } from '@wendellhu/redi';
 import { IContextService } from '../context/context.service';
 import { ILogService } from '../log/log.service';
-export declare const enum CommandType {
+export declare enum CommandType {
     /** Command could generate some operations or mutations. */
     COMMAND = 0,
     /** An operation that do not require conflict resolve.  */
@@ -31,7 +31,7 @@ export interface ICommand<P extends object = object, R = boolean> {
      */
     readonly id: string;
     readonly type: CommandType;
-    handler(accessor: IAccessor, params?: P): Promise<R> | R;
+    handler(accessor: IAccessor, params?: P, options?: IExecutionOptions): Promise<R> | R;
     /**
      * When this command is unregistered, this function would be called.
      *
@@ -103,8 +103,8 @@ export interface IExecutionOptions {
 }
 export type CommandListener = (commandInfo: Readonly<ICommandInfo>, options?: IExecutionOptions) => void;
 export interface ICommandService {
-    registerCommand(command: ICommand): IDisposable;
-    registerMultipleCommand(command: ICommand): IDisposable;
+    registerCommand(command: ICommand<object, unknown>): IDisposable;
+    registerMultipleCommand(command: ICommand<object, unknown>): 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;
     /**

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

@@ -22,4 +22,5 @@ export declare const EDITOR_ACTIVATED = "EDITOR_ACTIVATED";
 export declare const FOCUSING_EDITOR_INPUT_FORMULA = "FOCUSING_EDITOR_INPUT_FORMULA";
 export declare const FOCUSING_FORMULA_EDITOR = "FOCUSING_FORMULA_EDITOR";
 export declare const FOCUSING_UNIVER_EDITOR = "FOCUSING_UNIVER_EDITOR";
-export declare const FOCUSING_UNIVER_EDITOR_SINGLE_MODE = "FOCUSING_UNIVER_EDITOR_SINGLE_MODE";
+export declare const FOCUSING_EDITOR_STANDALONE = "FOCUSING_EDITOR_INPUT_FORMULA";
+export declare const FOCUSING_UNIVER_EDITOR_STANDALONE_SINGLE_MODE = "FOCUSING_UNIVER_EDITOR_STANDALONE_SINGLE_MODE";

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

@@ -18,10 +18,10 @@ import { DocumentDataModel } from '../../docs/data-model/document-data-model';
 import type { Nullable } from '../../shared';
 import { Disposable } from '../../shared/lifecycle';
 import { Workbook } from '../../sheets/workbook';
-import { Slide } from '../../slides/domain/slide-model';
+import { SlideDataModel } from '../../slides/domain/slide-model';
 import type { IDocumentData, ISlideData, IWorkbookData } from '../../types/interfaces';
 import { IContextService } from '../context/context.service';
-export declare const enum UniverInstanceType {
+export declare enum UniverInstanceType {
     UNKNOWN = 0,
     DOC = 1,
     SHEET = 2,
@@ -30,7 +30,7 @@ export declare const enum UniverInstanceType {
 export interface IUniverHandler {
     createUniverDoc(data: Partial<IDocumentData>): DocumentDataModel;
     createUniverSheet(data: Partial<IWorkbookData>): Workbook;
-    createUniverSlide(data: Partial<ISlideData>): Slide;
+    createUniverSlide(data: Partial<ISlideData>): SlideDataModel;
 }
 /**
  * IUniverInstanceService holds all the current univer instances. And it also manages
@@ -40,34 +40,34 @@ export interface IUniverInstanceService {
     focused$: Observable<Nullable<string>>;
     currentSheet$: Observable<Nullable<Workbook>>;
     currentDoc$: Observable<Nullable<DocumentDataModel>>;
-    currentSlide$: Observable<Nullable<Slide>>;
+    currentSlide$: Observable<Nullable<SlideDataModel>>;
     sheetAdded$: Observable<Workbook>;
     docAdded$: Observable<DocumentDataModel>;
-    slideAdded$: Observable<Slide>;
+    slideAdded$: Observable<SlideDataModel>;
     sheetDisposed$: Observable<Workbook>;
     docDisposed$: Observable<DocumentDataModel>;
-    slideDisposed$: Observable<Slide>;
+    slideDisposed$: Observable<SlideDataModel>;
     focusUniverInstance(id: string | null): void;
-    getFocusedUniverInstance(): Workbook | DocumentDataModel | Slide | null;
+    getFocusedUniverInstance(): Nullable<Workbook | DocumentDataModel | SlideDataModel>;
     createDoc(data: Partial<IDocumentData>): DocumentDataModel;
     createSheet(data: Partial<IWorkbookData>): Workbook;
-    createSlide(data: Partial<ISlideData>): Slide;
+    createSlide(data: Partial<ISlideData>): SlideDataModel;
     changeDoc(unitId: string, doc: DocumentDataModel): void;
     addDoc(doc: DocumentDataModel): void;
     addSheet(sheet: Workbook): void;
-    addSlide(slide: Slide): void;
+    addSlide(slide: SlideDataModel): void;
     getUniverSheetInstance(id: string): Nullable<Workbook>;
     getUniverDocInstance(id: string): Nullable<DocumentDataModel>;
-    getUniverSlideInstance(id: string): Nullable<Slide>;
+    getUniverSlideInstance(id: string): Nullable<SlideDataModel>;
     getCurrentUniverSheetInstance(): Workbook;
     getCurrentUniverDocInstance(): DocumentDataModel;
-    getCurrentUniverSlideInstance(): Slide;
+    getCurrentUniverSlideInstance(): SlideDataModel;
     setCurrentUniverSheetInstance(id: string): void;
     setCurrentUniverDocInstance(id: string): void;
     setCurrentUniverSlideInstance(id: string): void;
     getAllUniverSheetsInstance(): Workbook[];
     getAllUniverDocsInstance(): DocumentDataModel[];
-    getAllUniverSlidesInstance(): Slide[];
+    getAllUniverSlidesInstance(): SlideDataModel[];
     getDocumentType(unitId: string): UniverInstanceType;
     disposeDocument(unitId: string): boolean;
 }
@@ -83,19 +83,19 @@ export declare class UniverInstanceService extends Disposable implements IUniver
     private readonly _currentDoc$;
     readonly currentDoc$: Observable<Nullable<DocumentDataModel>>;
     private readonly _currentSlide$;
-    readonly currentSlide$: Observable<Nullable<Slide>>;
+    readonly currentSlide$: Observable<Nullable<SlideDataModel>>;
     private readonly _sheetAdded$;
     readonly sheetAdded$: Observable<Workbook>;
     private readonly _docAdded$;
     readonly docAdded$: Observable<DocumentDataModel>;
     private readonly _slideAdded$;
-    readonly slideAdded$: Observable<Slide>;
+    readonly slideAdded$: Observable<SlideDataModel>;
     private readonly _sheetDisposed$;
     readonly sheetDisposed$: Observable<Workbook>;
     private readonly _docDisposed$;
     readonly docDisposed$: Observable<DocumentDataModel>;
     private readonly _slideDisposed$;
-    readonly slideDisposed$: Observable<Slide>;
+    readonly slideDisposed$: Observable<SlideDataModel>;
     private readonly _sheets;
     private readonly _docs;
     private readonly _slides;
@@ -103,25 +103,25 @@ export declare class UniverInstanceService extends Disposable implements IUniver
     dispose(): void;
     createDoc(data: Partial<IDocumentData>): DocumentDataModel;
     createSheet(data: Partial<IWorkbookData>): Workbook;
-    createSlide(data: Partial<ISlideData>): Slide;
+    createSlide(data: Partial<ISlideData>): SlideDataModel;
     addSheet(sheet: Workbook): void;
     changeDoc(unitId: string, doc: DocumentDataModel): void;
     addDoc(doc: DocumentDataModel): void;
-    addSlide(slide: Slide): void;
+    addSlide(slide: SlideDataModel): void;
     getUniverSheetInstance(id: string): Nullable<Workbook>;
     getUniverDocInstance(id: string): Nullable<DocumentDataModel>;
-    getUniverSlideInstance(id: string): Nullable<Slide>;
+    getUniverSlideInstance(id: string): Nullable<SlideDataModel>;
     getAllUniverSheetsInstance(): Workbook[];
     getAllUniverDocsInstance(): DocumentDataModel[];
-    getAllUniverSlidesInstance(): Slide[];
+    getAllUniverSlidesInstance(): SlideDataModel[];
     setCurrentUniverSheetInstance(id: string): void;
     setCurrentUniverSlideInstance(id: string): void;
     setCurrentUniverDocInstance(id: string): void;
     getCurrentUniverSheetInstance(): Workbook;
     getCurrentUniverDocInstance(): DocumentDataModel;
-    getCurrentUniverSlideInstance(): Slide;
+    getCurrentUniverSlideInstance(): SlideDataModel;
     focusUniverInstance(id: string | null): void;
-    getFocusedUniverInstance(): Workbook | DocumentDataModel | Slide | null;
+    getFocusedUniverInstance(): Nullable<Workbook | DocumentDataModel | SlideDataModel>;
     getDocumentType(unitId: string): UniverInstanceType;
     disposeDocument(unitId: string): boolean;
 }

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

@@ -26,17 +26,18 @@ export declare class LocaleService extends Disposable {
     localeChanged$: Subject<void>;
     constructor();
     /**
-     * Load more locales after init
+     * Load more locales after init.
      *
      * @param locales - Locale object
-     *
      */
     load(locales: ILocales): void;
     /**
      * 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]: {
@@ -58,4 +59,5 @@ export declare class LocaleService extends Disposable {
     t: (key: string, ...args: string[]) => string;
     setLocale(locale: LocaleType): void;
     getLocales(): ILanguagePack | undefined;
+    getCurrentLocale(): LocaleType;
 }

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

@@ -0,0 +1,18 @@
+/**
+ * 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 interface ILogContext {
+    metadata?: Record<string, string>;
+}

package/lib/types/services/snapshot/__tests__/snapshot-mock.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetRequest, ISaveChangesetResponse, ISaveSheetBlockRequest, ISaveSheetBlockResponse, ISaveSnapshotRequest, ISaveSnapshotResponse, ISheetBlock, ISnapshot } from '@univerjs/protocol';
+import type { IWorkbookData } from '../../../types/interfaces/i-workbook-data';
+import type { ILogContext } from '../../log/context';
+import type { ISnapshotServerService } from '../snapshot-server.service';
+export declare const testSnapshot: () => ISnapshot;
+export declare const testSheetBlocks: () => ISheetBlock[];
+export declare const testWorkbookData: () => IWorkbookData;
+export declare class MockSnapshotServerService implements ISnapshotServerService {
+    /** Load snapshot from a database. */
+    getUnitOnRev(context: ILogContext, params: IGetUnitOnRevRequest): Promise<IGetUnitOnRevResponse>;
+    /** Load sheet block from a database.  */
+    getSheetBlock(context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetSheetBlockResponse>;
+    /** Fetch missing changeset */
+    fetchMissingChangesets(context: ILogContext, params: IFetchMissingChangesetsRequest): Promise<IFetchMissingChangesetsResponse>;
+    getResourcesRequest(context: ILogContext, params: IGetResourcesRequest): Promise<IGetResourcesResponse>;
+    /** Save snapshot to a database. */
+    saveSnapshot(context: ILogContext, params: ISaveSnapshotRequest): Promise<ISaveSnapshotResponse>;
+    /** Save sheet block to a database. */
+    saveSheetBlock(context: ILogContext, params: ISaveSheetBlockRequest): Promise<ISaveSheetBlockResponse>;
+    /** Save changeset to a database. */
+    saveChangeset(context: ILogContext, params: ISaveChangesetRequest): Promise<ISaveChangesetResponse>;
+}

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

@@ -0,0 +1,57 @@
+/**
+ * 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 { IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetRequest, ISaveChangesetResponse, ISaveSheetBlockRequest, ISaveSheetBlockResponse, ISaveSnapshotRequest, ISaveSnapshotResponse } from '@univerjs/protocol';
+import type { ILogContext } from '../log/context';
+/**
+ * It provides implementations for server side controllers to load or save
+ * or load snapshots. This service should be implemented by the host environment.
+ * And it shouldn't contain any business logic.
+ */
+export declare const ISnapshotServerService: import("@wendellhu/redi").IdentifierDecorator<ISnapshotServerService>;
+export interface ISnapshotServerService {
+    /** Load snapshot from a database. */
+    getUnitOnRev: (context: ILogContext, params: IGetUnitOnRevRequest) => Promise<IGetUnitOnRevResponse>;
+    /** Load sheet block from a database.  */
+    getSheetBlock: (context: ILogContext, params: IGetSheetBlockRequest) => Promise<IGetSheetBlockResponse>;
+    /** Fetch missing changeset */
+    fetchMissingChangesets: (context: ILogContext, params: IFetchMissingChangesetsRequest) => Promise<IFetchMissingChangesetsResponse>;
+    getResourcesRequest: (context: ILogContext, params: IGetResourcesRequest) => Promise<IGetResourcesResponse>;
+    /** Save snapshot to a database. */
+    saveSnapshot: (context: ILogContext, params: ISaveSnapshotRequest) => Promise<ISaveSnapshotResponse>;
+    /** Save sheet block to a database. */
+    saveSheetBlock: (context: ILogContext, params: ISaveSheetBlockRequest) => Promise<ISaveSheetBlockResponse>;
+    /** Save changeset to a database. */
+    saveChangeset: (context: ILogContext, params: ISaveChangesetRequest) => Promise<ISaveChangesetResponse>;
+}
+/**
+ * The server needs to fully implement all interfaces, but when used by the client, use saveSheetBlock to cache the sheet block locally, and use getSheetBlock to obtain the sheet block.
+ */
+export declare class ClientSnapshotServerService implements ISnapshotServerService {
+    private _sheetBlockCache;
+    /** Load snapshot from a database. */
+    getUnitOnRev(context: ILogContext, params: IGetUnitOnRevRequest): Promise<IGetUnitOnRevResponse>;
+    /** Load sheet block from a database.  */
+    getSheetBlock(context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetSheetBlockResponse>;
+    /** Fetch missing changeset */
+    fetchMissingChangesets(context: ILogContext, params: IFetchMissingChangesetsRequest): Promise<IFetchMissingChangesetsResponse>;
+    getResourcesRequest(context: ILogContext, params: IGetResourcesRequest): Promise<IGetResourcesResponse>;
+    /** Save snapshot to a database. */
+    saveSnapshot(context: ILogContext, params: ISaveSnapshotRequest): Promise<ISaveSnapshotResponse>;
+    /** Save sheet block to a database. */
+    saveSheetBlock(context: ILogContext, params: ISaveSheetBlockRequest): Promise<ISaveSheetBlockResponse>;
+    /** Save changeset to a database. */
+    saveChangeset(context: ILogContext, params: ISaveChangesetRequest): Promise<ISaveChangesetResponse>;
+}

package/lib/types/services/snapshot/snapshot-transform.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { ISheetBlock, ISnapshot } from '@univerjs/protocol';
+import type { ILogContext } from '../log/context';
+import type { IWorkbookData } from '../../types/interfaces/i-workbook-data';
+import type { IDocumentData } from '../../types/interfaces/i-document-data';
+import type { ISnapshotServerService } from './snapshot-server.service';
+export declare function generateTemporarySnap(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+    snapshotRes: ISnapshot;
+}>;
+export declare function transformWorkbookDataToSnapshot(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+    snapshot: ISnapshot;
+}>;
+/**
+ * Assemble a snapshot to a workbook.
+ * @param snapshot
+ * @param sheetBlocks
+ */
+export declare function transformSnapshotToWorkbookData(snapshot: ISnapshot, sheetBlocks: ISheetBlock[], _context?: ILogContext): IWorkbookData;
+export declare function transformSnapshotToDocumentData(snapshot: ISnapshot): IDocumentData;
+export declare function transformDocumentDataToSnapshot(context: ILogContext, document: IDocumentData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+    snapshot: ISnapshot;
+}>;
+/**
+ *
+ * @param snapshot
+ * @param snapshotService
+ * @returns
+ */
+export declare function getSheetBlocksFromSnapshot(snapshot: ISnapshot, snapshotService: ISnapshotServerService): Promise<ISheetBlock[]>;

package/lib/types/services/snapshot/snapshot-utils.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { ISheetBlock } from '@univerjs/protocol';
+import type { IWorksheetData } from '../../types/interfaces/i-worksheet-data';
+import type { IWorkbookData } from '../../types/interfaces/i-workbook-data';
+import type { IDocumentData } from '../../types/interfaces/i-document-data';
+import type { ICellData } from '../../types/interfaces/i-cell-data';
+import type { IObjectMatrixPrimitiveType } from '../../shared/object-matrix';
+export declare const textEncoder: TextEncoder;
+export declare const textDecoder: TextDecoder;
+/**
+ * @param worksheet
+ */
+export declare function encodeWorksheetOtherMetas(worksheet: Partial<IWorksheetData>): Uint8Array;
+export declare function encodeWorkbookOtherMetas(workbook: IWorkbookData): Uint8Array;
+export declare function encodeDocOriginalMeta(document: IDocumentData): Uint8Array;
+export declare function decodeWorksheetOtherMetas(buffer: Uint8Array): Partial<IWorksheetData>;
+export declare function decodeWorkbookOtherMetas(buffer: Uint8Array): Partial<IWorkbookData>;
+export declare function decodePartOfCellData(buffer: Uint8Array | string): IObjectMatrixPrimitiveType<ICellData>;
+export declare function decodeDocOriginalMeta(buffer: Uint8Array | string): Partial<IDocumentData>;
+export declare function splitCellDataToBlocks(cellData: IObjectMatrixPrimitiveType<ICellData>, maxColumn: number): ISheetBlock[];

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IAccessor } from '@wendellhu/redi';
+import type { IAccessor, IDisposable } from '@wendellhu/redi';
 import type { Observable } from 'rxjs';
 import { BehaviorSubject } from 'rxjs';
 import { Disposable } from '../../shared/lifecycle';
@@ -21,22 +21,30 @@ import type { IMutationInfo } from '../command/command.service';
 import { CommandType, ICommandService } from '../command/command.service';
 import { IContextService } from '../context/context.service';
 import { IUniverInstanceService } from '../instance/instance.service';
+import type { Nullable } from '../../common/type-utils';
 export interface IUndoRedoItem {
     /** unitID maps to unitId for UniverSheet / UniverDoc / UniverSlide */
     unitID: string;
     undoMutations: IMutationInfo[];
     redoMutations: IMutationInfo[];
-    undo?(mutations: IMutationInfo[]): Promise<boolean> | boolean;
-    redo?(mutations: IMutationInfo[]): Promise<boolean> | boolean;
 }
 export interface IUndoRedoService {
     undoRedoStatus$: Observable<IUndoRedoStatus>;
     pushUndoRedo(item: IUndoRedoItem): void;
-    pitchTopUndoElement(): IUndoRedoItem | null;
-    pitchTopRedoElement(): IUndoRedoItem | null;
+    /** Pitch the top redo element of the currently focused Univer document instance. */
+    pitchTopUndoElement(): Nullable<IUndoRedoItem>;
+    /** Pitch the top undo element of the currently focused Univer document instance. */
+    pitchTopRedoElement(): Nullable<IUndoRedoItem>;
     popUndoToRedo(): void;
     popRedoToUndo(): void;
     clearUndoRedo(unitID: string): void;
+    /**
+     * Batch undo redo elements into a single `IUndoRedoItem` util the returned `IDisposable` is called.
+     *
+     * @deprecated This is a temporary solution. We are going to refactor the undo redo service shortly.
+     * @returns a disposable to cancel batching undo redo elements
+     */
+    __tempBatchingUndoRedo(unitId: string): IDisposable;
 }
 export interface IUndoRedoCommandInfos {
     undos: IMutationInfo[];
@@ -77,13 +85,17 @@ export declare class LocalUndoRedoService extends Disposable implements IUndoRed
     }>;
     protected readonly _undoStacks: Map<string, IUndoRedoItem[]>;
     protected readonly _redoStacks: Map<string, IUndoRedoItem[]>;
+    private _batchingStatus;
     constructor(_univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _contextService: IContextService);
     pushUndoRedo(item: IUndoRedoItem): void;
     clearUndoRedo(unitID: string): void;
-    pitchTopUndoElement(): IUndoRedoItem | null;
-    pitchTopRedoElement(): IUndoRedoItem | null;
+    pitchTopUndoElement(): Nullable<IUndoRedoItem>;
+    pitchTopRedoElement(): Nullable<IUndoRedoItem>;
+    private _pitchUndoElement;
+    private _pitchRedoElement;
     popUndoToRedo(): void;
     popRedoToUndo(): void;
+    __tempBatchingUndoRedo(unitId: string): IDisposable;
     protected _updateStatus(): void;
     protected _getUndoStack(unitId: string): IUndoRedoItem[] | null;
     protected _getUndoStack(unitId: string, createAsNeeded: true): IUndoRedoItem[];
@@ -91,5 +103,6 @@ export declare class LocalUndoRedoService extends Disposable implements IUndoRed
     protected _getRedoStack(unitId: string, createAsNeeded: true): IUndoRedoItem[];
     protected _getUndoStackForFocused(): IUndoRedoItem[];
     protected _getRedoStackForFocused(): IUndoRedoItem[];
+    private _tryBatchingElements;
     private _getFocusedUniverInstanceId;
 }

package/lib/types/shared/__test__/rectangle.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 {};