@univerjs/core 0.1.1 → 0.1.3

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/__tests__/replacement.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/docs/data-model/replacement.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 { IDocumentBody } from '../../types/interfaces/i-document-data';
+export declare function replaceInDocumentBody(body: IDocumentBody, query: string, target: string): IDocumentBody;

package/lib/types/docs/data-model/text-x/text-x.d.ts

@@ -19,9 +19,9 @@ import { type TextXAction } from '../action-types';
 export declare class TextX {
     static compose(thisActions: TextXAction[], otherActions: TextXAction[]): TextXAction[];
     private _actions;
-    insert(len: number, body: IDocumentBody, segmentId: string): this;
-    retain(len: number, segmentId: string, body?: IDocumentBody, coverType?: UpdateDocsAttributeType): this;
-    delete(len: number, segmentId: string): this;
+    insert(len: number, body: IDocumentBody, segmentId?: string): this;
+    retain(len: number, segmentId?: string, body?: IDocumentBody, coverType?: UpdateDocsAttributeType): this;
+    delete(len: number, segmentId?: string): this;
     serialize(): TextXAction[];
     push(...args: TextXAction[]): this;
     trimEndUselessRetainAction(): this;

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';
@@ -25,6 +25,7 @@ export { TextXActionType, type TextXAction, type IDeleteAction, type IInsertActi
 export { ActionIterator } from './docs/data-model/text-x/action-iterator';
 export { getBodySlice, composeBody } from './docs/data-model/text-x/utils';
 export { TextX } from './docs/data-model/text-x/text-x';
+export { replaceInDocumentBody } from './docs/data-model/replacement';
 export * from './observer';
 export { Plugin, PluginType } from './plugin/plugin';
 export { type CommandListener, CommandService, CommandType, type ICommand, type ICommandInfo, ICommandService, type IExecutionOptions, type IMultiCommand, type IMutation, type IMutationCommonParams, type IMutationInfo, type IOperation, type IOperationInfo, NilCommand, sequenceExecute, sequenceExecuteAsync, } from './services/command/command.service';
@@ -47,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';
@@ -61,3 +63,14 @@ export * from './slides/domain';
 export * from './types/const';
 export * from './types/enum';
 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,3 +22,4 @@ 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";

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

@@ -21,7 +21,7 @@ import { Workbook } from '../../sheets/workbook';
 import { Slide } 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,

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/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/debounce.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.
+ */
+type debounceFn<T extends (...args: any[]) => any> = (this: ThisParameterType<T>, ...args: Parameters<T>) => void;
+export declare function debounce<T extends (...args: any[]) => any>(func: T, wait: number): debounceFn<T>;
+export {};

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

@@ -18,4 +18,4 @@
  * @param val The number or string to be judged
  * @returns Result
  */
-export declare function isRealNum(val: string | number): boolean;
+export declare function isRealNum(val: string | number | boolean): boolean;

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';
@@ -35,3 +35,4 @@ export * from './sequence';
 export * from './sort-rules';
 export * from './tools';
 export * from './types';
+export * from './debounce';

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;