@univerjs/core 0.4.2 → 0.5.0-beta.0

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

@@ -26,3 +26,20 @@ export declare class InterceptorManager<P extends Record<string, IInterceptor<an
     getInterceptPoints(): P;
     dispose(): void;
 }
+export declare function createAsyncInterceptorKey<T, C>(key: string): IAsyncInterceptor<T, C>;
+export type AsyncInterceptorHandler<M = unknown, C = unknown> = (value: Nullable<M>, context: C, next: (value: Nullable<M>) => Promise<Nullable<M>>) => Promise<Nullable<M>>;
+export interface IAsyncInterceptor<M, C> {
+    priority?: number;
+    handler: AsyncInterceptorHandler<M, C>;
+}
+export type IComposeAsyncInterceptors<T = any, C = any> = (interceptors: Array<IAsyncInterceptor<T, C>>) => (initValue: Nullable<T>, initContext: C) => Promise<Nullable<T>>;
+export declare const composeAsyncInterceptors: <T, C>(interceptors: Array<IAsyncInterceptor<T, C>>) => ((initialValue: Nullable<T>, context: C) => Promise<Nullable<T>>);
+export declare class AsyncInterceptorManager<P extends Record<string, IAsyncInterceptor<any, any>>> {
+    private _asyncInterceptorsByName;
+    private _asyncInterceptorPoints;
+    constructor(asyncInterceptorPoints: P);
+    fetchThroughAsyncInterceptors<T, C>(name: IAsyncInterceptor<T, C>): (initialValue: Nullable<T>, context: C) => Promise<Nullable<T>>;
+    interceptAsync<T extends IAsyncInterceptor<any, any>>(name: T, interceptor: T): Promise<() => boolean>;
+    getInterceptPoints(): P;
+    dispose(): void;
+}

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

@@ -1,2 +1,2 @@
 import { IDocumentBody } from '../../types/interfaces/i-document-data';
-export declare function replaceInDocumentBody(body: IDocumentBody, query: string, target: string): IDocumentBody;
+export declare function replaceInDocumentBody(body: IDocumentBody, query: string, target: string, caseSensitive: boolean): IDocumentBody;

package/lib/types/docs/data-model/text-x/__tests__/apply-consistency.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/text-x/__tests__/delete-apply.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/text-x/__tests__/transform-custom-decorations.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/text-x/__tests__/transform-custom-range.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/text-x/__tests__/transform-paragraph.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/text-x/__tests__/transform-textrun.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/text-x/apply-utils/common.d.ts

@@ -1,5 +1,5 @@
 import { ICustomBlock, ICustomDecoration, ICustomRange, ICustomTable, IDocumentBody, IParagraph, ISectionBreak, ITextRun } from '../../../../types/interfaces';
-export declare function normalizeTextRuns(textRuns: ITextRun[]): ITextRun[];
+export declare function normalizeTextRuns(textRuns: ITextRun[], reserveEmptyTextRun?: boolean): ITextRun[];
 /**
  * Inserting styled text content into the current document model.
  * @param body The current content object of the document model.
@@ -20,6 +20,11 @@ export declare function insertParagraphs(body: IDocumentBody, insertBody: IDocum
 export declare function insertSectionBreaks(body: IDocumentBody, insertBody: IDocumentBody, textLength: number, currentIndex: number): void;
 export declare function insertCustomBlocks(body: IDocumentBody, insertBody: IDocumentBody, textLength: number, currentIndex: number): void;
 export declare function insertTables(body: IDocumentBody, insertBody: IDocumentBody, textLength: number, currentIndex: number): void;
+export declare function sliceByParagraph(body: IDocumentBody): IDocumentBody[];
+export declare function mergeContinuousRanges(ranges: ICustomRange[]): ICustomRange[];
+export declare function splitCustomRangesByIndex(customRanges: ICustomRange[], currentIndex: number): void;
+export declare function mergeContinuousDecorations(ranges: ICustomDecoration[]): ICustomDecoration[];
+export declare function splitCustomDecoratesByIndex(customDecorations: ICustomDecoration[], currentIndex: number): void;
 export declare function insertCustomRanges(body: IDocumentBody, insertBody: IDocumentBody, textLength: number, currentIndex: number): void;
 export declare function mergeDecorations(customDecorations: ICustomDecoration[]): ICustomDecoration[];
 export declare function insertCustomDecorations(body: IDocumentBody, insertBody: IDocumentBody, textLength: number, currentIndex: number): void;

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

@@ -1,4 +1,4 @@
-import { IDocumentBody, ITextRun } from '../../../../types/interfaces';
 import { UpdateDocsAttributeType } from '../../../../shared';
+import { IDocumentBody, ITextRun } from '../../../../types/interfaces';
 export declare function updateAttribute(body: IDocumentBody, updateBody: IDocumentBody, textLength: number, currentIndex: number, coverType: UpdateDocsAttributeType): IDocumentBody;
-export declare function coverTextRuns(updateDataTextRuns: ITextRun[], removeTextRuns: ITextRun[], coverType: UpdateDocsAttributeType): ITextRun[];
+export declare function coverTextRuns(updateDataTextRuns: ITextRun[], originTextRuns: ITextRun[], coverType: UpdateDocsAttributeType): ITextRun[];

package/lib/types/docs/data-model/text-x/build-utils/__test__/textX.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/text-x/build-utils/custom-decoration.d.ts

@@ -0,0 +1,17 @@
+import { ITextRange } from '../../../../sheets/typedef';
+import { DocumentDataModel } from '../../document-data-model';
+import { CustomDecorationType } from '../../../../types/interfaces';
+import { TextX } from '../text-x';
+interface IAddCustomDecorationParam {
+    ranges: ITextRange[];
+    id: string;
+    type: CustomDecorationType;
+}
+export declare function addCustomDecorationTextX(param: IAddCustomDecorationParam): TextX;
+export interface IDeleteCustomRangeParam {
+    id: string;
+    segmentId?: string;
+    documentDataModel: DocumentDataModel;
+}
+export declare function deleteCustomDecorationTextX(params: IDeleteCustomRangeParam): false | TextX;
+export {};

package/lib/types/docs/data-model/text-x/build-utils/custom-range.d.ts

@@ -1,7 +1,5 @@
 import { ITextRange } from '../../../../sheets/typedef';
-import { ICustomRange } from '../../../../types/interfaces';
-import { DataStreamTreeTokenType } from '../../types';
-export declare function isCustomRangeSplitSymbol(text: string): text is DataStreamTreeTokenType.CUSTOM_RANGE_START | DataStreamTreeTokenType.CUSTOM_RANGE_END;
+import { CustomRangeType, ICustomRange, IDocumentBody } from '../../../../types/interfaces';
 /**
  * Check if two ranges intersect
  * @param line1Start - The start of the first range
@@ -11,14 +9,26 @@ export declare function isCustomRangeSplitSymbol(text: string): text is DataStre
  * @returns True if the ranges intersect, false otherwise
  */
 export declare function isIntersecting(line1Start: number, line1End: number, line2Start: number, line2End: number): boolean;
-export declare function shouldDeleteCustomRange(deleteStart: number, deleteLen: number, customRange: ICustomRange, dataStream: string): boolean;
 export declare function getCustomRangesInterestsWithSelection(range: ITextRange, customRanges: ICustomRange[]): ICustomRange<Record<string, any>>[];
 export declare function copyCustomRange(range: ICustomRange): {
     rangeId: string;
     startIndex: number;
     endIndex: number;
-    rangeType: import('../../../..').CustomRangeType | number;
+    rangeType: CustomRangeType | number;
     wholeEntity?: boolean;
     properties?: Record<string, any> | undefined;
 };
 export declare function excludePointsFromRange(range: [number, number], points: number[]): [number, number][];
+export declare function getIntersectingCustomRanges(startIndex: number, endIndex: number, customRanges: ICustomRange[], rangeType?: CustomRangeType): {
+    startIndex: number;
+    endIndex: number;
+    rangeId: string;
+    rangeType: CustomRangeType | number;
+    wholeEntity?: boolean;
+    properties?: Record<string, any> | undefined;
+}[];
+export declare function getSelectionForAddCustomRange(range: ITextRange, body: IDocumentBody): {
+    startOffset: number;
+    endOffset: number;
+    collapsed: boolean;
+};

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

@@ -1,23 +1,24 @@
-import { copyCustomRange, getCustomRangesInterestsWithSelection, isIntersecting, shouldDeleteCustomRange } from './custom-range';
-import { getDeleteSelection, getInsertSelection, getRetainAndDeleteFromReplace, isSegmentIntersects, makeSelection, normalizeSelection } from './selection';
-import { addCustomRangeTextX, deleteCustomRangeTextX, getRetainAndDeleteAndExcludeLineBreak } from './text-x-utils';
+import { addCustomDecorationTextX, deleteCustomDecorationTextX } from './custom-decoration';
+import { copyCustomRange, getCustomRangesInterestsWithSelection, isIntersecting } from './custom-range';
+import { isSegmentIntersects, makeSelection, normalizeSelection } from './selection';
+import { addCustomRangeTextX, deleteCustomRangeTextX, deleteSelectionTextX } from './text-x-utils';
 export declare class BuildTextUtils {
     static customRange: {
         add: typeof addCustomRangeTextX;
         delete: typeof deleteCustomRangeTextX;
         copyCustomRange: typeof copyCustomRange;
         getCustomRangesInterestsWithSelection: typeof getCustomRangesInterestsWithSelection;
-        shouldDeleteCustomRange: typeof shouldDeleteCustomRange;
         isIntersecting: typeof isIntersecting;
     };
+    static customDecoration: {
+        add: typeof addCustomDecorationTextX;
+        delete: typeof deleteCustomDecorationTextX;
+    };
     static selection: {
         replace: (params: import('./text-x-utils').IReplaceSelectionTextXParams) => false | import('../text-x').TextX;
         makeSelection: typeof makeSelection;
         normalizeSelection: typeof normalizeSelection;
-        getDeleteSelection: typeof getDeleteSelection;
-        getInsertSelection: typeof getInsertSelection;
-        getDeleteActions: typeof getRetainAndDeleteFromReplace;
-        getDeleteExcludeLastLineBreakActions: typeof getRetainAndDeleteAndExcludeLineBreak;
+        delete: typeof deleteSelectionTextX;
     };
     static range: {
         isIntersects: typeof isSegmentIntersects;

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

@@ -1,29 +1,4 @@
-import { Nullable } from '../../../../shared';
 import { ITextRange } from '../../../../sheets/typedef';
-import { IDocumentBody } from '../../../../types/interfaces';
-import { IDeleteAction, IRetainAction } from '../action-types';
-import { DeleteDirection } from '../../../../types/enum';
 export declare function makeSelection(startOffset: number, endOffset?: number): ITextRange;
 export declare function normalizeSelection(selection: ITextRange): ITextRange;
-export declare function getSelectionWithSymbolMax(selection: ITextRange, body: IDocumentBody): {
-    startOffset: number;
-    endOffset: number;
-};
-export declare function getSelectionWithNoSymbolSide(selection: ITextRange, body: IDocumentBody): {
-    startOffset: number;
-    endOffset: number;
-};
-export declare function getDeleteSelection<T extends ITextRange>(selection: T, body: IDocumentBody, direction?: DeleteDirection): T;
-export declare function getInsertSelection<T extends ITextRange>(selection: T, body: IDocumentBody): T;
-/**
- * Ensure custom-range has a correct order,
- * when range contains range, it won't be present as intersect. <br/>
- * For Example `\s1\s2 text \s1\s2` is not allowed, expect `\s1\s2 text \s2\s1`
- */
-export declare function getSelectionForAddCustomRange(selection: ITextRange, body: IDocumentBody): Nullable<ITextRange>;
 export declare function isSegmentIntersects(start: number, end: number, start2: number, end2: number): boolean;
-export declare function getRetainAndDeleteFromReplace(range: ITextRange, segmentId: string | undefined, memoryCursor: number, body: IDocumentBody): {
-    dos: (IRetainAction | IDeleteAction)[];
-    cursor: number;
-    retain: number;
-};

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

@@ -2,19 +2,16 @@ import { IAccessor } from '@wendellhu/redi';
 import { ITextRange, ITextRangeParam } from '../../../../sheets/typedef';
 import { CustomRangeType, IDocumentBody } from '../../../../types/interfaces';
 import { DocumentDataModel } from '../../document-data-model';
-import { IDeleteAction, IRetainAction } from '../action-types';
+import { TextXAction } from '../action-types';
+import { TextXSelection, TextX } from '../text-x';
 import { Nullable } from '../../../../shared';
-import { TextX } from '../text-x';
 export interface IDeleteCustomRangeParam {
     rangeId: string;
     segmentId?: string;
     documentDataModel: DocumentDataModel;
     insert?: Nullable<IDocumentBody>;
-    textRange?: {
-        index: number;
-    };
 }
-export declare function deleteCustomRangeTextX(accessor: IAccessor, params: IDeleteCustomRangeParam): false | TextX;
+export declare function deleteCustomRangeTextX(accessor: IAccessor, params: IDeleteCustomRangeParam): false | TextXSelection;
 export interface IAddCustomRangeTextXParam {
     range: ITextRange;
     segmentId?: string;
@@ -24,8 +21,10 @@ export interface IAddCustomRangeTextXParam {
     wholeEntity?: boolean;
     body: IDocumentBody;
 }
-export declare function addCustomRangeTextX(param: IAddCustomRangeTextXParam): false | TextX;
-export declare function getRetainAndDeleteAndExcludeLineBreak(selection: ITextRange, body: IDocumentBody, segmentId?: string, memoryCursor?: number, preserveLineBreak?: boolean): Array<IRetainAction | IDeleteAction>;
+export declare function addCustomRangeTextX(param: IAddCustomRangeTextXParam): false | (TextX & {
+    selections?: ITextRange[];
+});
+export declare function deleteSelectionTextX(selections: ITextRange[], body: IDocumentBody, memoryCursor?: number, insertBody?: Nullable<IDocumentBody>, keepBullet?: boolean): Array<TextXAction>;
 export interface IReplaceSelectionTextXParams {
     /**
      * range to be replaced.

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

@@ -1,3 +1,4 @@
+import { ITextRange } from '../../../sheets/typedef';
 import { IDocumentBody } from '../../../types/interfaces/i-document-data';
 import { UpdateDocsAttributeType } from '../../../shared/command-enum';
 import { TextXAction } from './action-types';
@@ -50,3 +51,6 @@ export declare class TextX {
     push(...args: TextXAction[]): this;
     protected trimEndUselessRetainAction(): this;
 }
+export type TextXSelection = TextX & {
+    selections?: ITextRange[];
+};

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

@@ -1,3 +1,9 @@
-import { IDocumentBody } from '../../../types/interfaces';
 import { IRetainAction } from './action-types';
-export declare function transformBody(thisAction: IRetainAction, otherAction: IRetainAction, priority?: boolean): IDocumentBody;
+import { UpdateDocsAttributeType } from '../../../shared';
+import { IDocumentBody } from '../../../types/interfaces';
+interface ITransformBodyResult {
+    body: IDocumentBody;
+    coverType: UpdateDocsAttributeType;
+}
+export declare function transformBody(thisAction: IRetainAction, otherAction: IRetainAction, priority?: boolean): ITransformBodyResult;
+export {};

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

@@ -5,9 +5,13 @@ export declare enum SliceBodyType {
     copy = 0,
     cut = 1
 }
-export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyTextRun?: boolean, type?: SliceBodyType): IDocumentBody;
+export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyArray?: boolean, type?: SliceBodyType): IDocumentBody;
 export declare function normalizeBody(body: IDocumentBody): IDocumentBody;
 export declare function getCustomRangeSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
+    customRanges?: undefined;
+    leftOffset?: undefined;
+    rightOffset?: undefined;
+} | {
     customRanges: {
         startIndex: number;
         endIndex: number;
@@ -19,6 +23,6 @@ export declare function getCustomRangeSlice(body: IDocumentBody, startOffset: nu
     leftOffset: number;
     rightOffset: number;
 };
-export declare function getCustomDecorationSlice(body: IDocumentBody, startOffset: number, endOffset: number): ICustomDecoration[];
+export declare function getCustomDecorationSlice(body: IDocumentBody, startOffset: number, endOffset: number): ICustomDecoration[] | undefined;
 export declare function composeBody(thisBody: IDocumentBody, otherBody: IDocumentBody, coverType?: UpdateDocsAttributeType): IDocumentBody;
 export declare function isUselessRetainAction(action: IRetainAction): boolean;

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

@@ -30,7 +30,13 @@ export declare enum DataStreamTreeTokenType {
     TABLE_CELL_END = "\u001D",// 表格单元格结束
     TABLE_ROW_END = "\u000E",// 表格行结束
     TABLE_END = "\u000F",// 表格结束
+    /**
+     * @deprecated
+     */
     CUSTOM_RANGE_START = "\u001F",// 自定义范围开始
+    /**
+     * @deprecated
+     */
     CUSTOM_RANGE_END = "\u001E",// 自定义范围结束
     COLUMN_BREAK = "\v",// 换列
     PAGE_BREAK = "\f",// 换页

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

@@ -0,0 +1,20 @@
+import { IStyleBase, ITextRotation } from '../../types/interfaces';
+export declare const DEFAULT_FONTFACE_PLANE = "\"Helvetica Neue\", Helvetica, Arial, \"PingFang SC\", \"Hiragino Sans GB\", \"Heiti SC\", \"Microsoft YaHei\", \"WenQuanYi Micro Hei\", sans-serif";
+export interface IDocumentSkeletonFontStyle {
+    fontString: string;
+    fontSize: number;
+    originFontSize: number;
+    fontFamily: string;
+    fontCache: string;
+}
+export declare function getFontStyleString(textStyle?: IStyleBase): IDocumentSkeletonFontStyle;
+export declare function getBaselineOffsetInfo(_fontFamily: string, fontSize: number): {
+    sbr: number;
+    sbo: number;
+    spr: number;
+    spo: number;
+};
+export declare function convertTextRotation(textRotation?: ITextRotation): {
+    centerAngle: number;
+    vertexAngle: number;
+};

package/lib/types/facade/f-base.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * `FBase` is a base class for all facade classes.
+ * It provides a way to extend classes with static and instance methods.
+ * The `_initialize` as a special method that will be called after the constructor. You should never call it directly.
+ */
+export declare abstract class FBase {
+    private static _constructorQueue;
+    constructor();
+    _initialize(): void;
+    static extend(source: any): void;
+}

package/lib/types/facade/f-hooks.d.ts

@@ -0,0 +1,57 @@
+import { IDisposable, Injector } from '../common/di';
+import { IUndoRedoItem } from '../services/undoredo/undoredo.service';
+import { LifecycleService } from '../services/lifecycle/lifecycle.service';
+import { FBase } from './f-base';
+export declare class FHooks extends FBase {
+    protected readonly _injector: Injector;
+    private readonly _lifecycleService;
+    constructor(_injector: Injector, _lifecycleService: LifecycleService);
+    /**
+     * The onStarting event is fired when lifecycle stage is Starting.
+     * @param callback Callback function that will be called when the event is fired
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onStarting(callback: () => void): IDisposable;
+    /**
+     * The onReady event is fired when lifecycle stage is Ready.
+     * @param callback Callback function that will be called when the event is fired
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onReady(callback: () => void): IDisposable;
+    /**
+     * The onRendered event is fired when lifecycle stage is Rendered.
+     * @param callback Callback function that will be called when the event is fired
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onRendered(callback: () => void): IDisposable;
+    /**
+     * The onSteady event is fired when lifecycle stage is Steady.
+     * @param callback Callback function that will be called when the event is fired
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onSteady(callback: () => void): IDisposable;
+    /**
+     * Hook that fires before an undo operation is executed.
+     * @param callback Function to be called when the event is triggered
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onBeforeUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
+    /**
+     * Hook that fires after an undo operation is executed.
+     * @param callback Function to be called when the event is triggered
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
+    /**
+     * Hook that fires before a redo operation is executed.
+     * @param callback Function to be called when the event is triggered
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onBeforeRedo(callback: (action: IUndoRedoItem) => void): IDisposable;
+    /**
+     * Hook that fires after a redo operation is executed.
+     * @param callback Function to be called when the event is triggered
+     * @returns A disposable object that can be used to unsubscribe from the event
+     */
+    onRedo(callback: (action: IUndoRedoItem) => void): IDisposable;
+}

package/lib/types/facade/f-univer.d.ts

@@ -0,0 +1,76 @@
+import { IDisposable, Injector } from '../common/di';
+import { CommandListener, IExecutionOptions, ICommandService } from '../services/command/command.service';
+import { LifecycleStages } from '../services/lifecycle/lifecycle';
+import { IUniverInstanceService } from '../services/instance/instance.service';
+import { Univer } from '../univer';
+import { FBase } from './f-base';
+import { FHooks } from './f-hooks';
+export declare class FUniver extends FBase {
+    protected readonly _injector: Injector;
+    protected readonly _commandService: ICommandService;
+    protected readonly _univerInstanceService: IUniverInstanceService;
+    /**
+     * Create an FUniver instance, if the injector is not provided, it will create a new Univer instance.
+     *
+     * @static
+     *
+     * @param {Univer | Injector} wrapped - The Univer instance or injector instance.
+     * @returns {FUniver} - The FUniver instance.
+     */
+    static newAPI(wrapped: Univer | Injector): FUniver;
+    constructor(_injector: Injector, _commandService: ICommandService, _univerInstanceService: IUniverInstanceService);
+    /**
+     * Dispose the UniverSheet by the `unitId`. The UniverSheet would be unload from the application.
+     *
+     * @param unitId The unit id of the UniverSheet.
+     * @returns Whether the Univer instance is disposed successfully.
+     */
+    disposeUnit(unitId: string): boolean;
+    /**
+     * Get the current lifecycle stage.
+     *
+     * @returns {LifecycleStages} - The current lifecycle stage.
+     */
+    getCurrentLifecycleStage(): LifecycleStages;
+    /**
+     * Undo an editing on the currently focused document.
+     *
+     * @returns {Promise<boolean>} undo result
+     */
+    undo(): Promise<boolean>;
+    /**
+     * Redo an editing on the currently focused document.
+     *
+     * @returns {Promise<boolean>} redo result
+     */
+    redo(): Promise<boolean>;
+    /**
+     * Register a callback that will be triggered before invoking a command.
+     *
+     * @param {CommandListener} callback The callback.
+     * @returns {IDisposable} The disposable instance.
+     */
+    onBeforeCommandExecute(callback: CommandListener): IDisposable;
+    /**
+     * Register a callback that will be triggered when a command is invoked.
+     *
+     * @param {CommandListener} callback The callback.
+     * @returns {IDisposable} The disposable instance.
+     */
+    onCommandExecuted(callback: CommandListener): IDisposable;
+    /**
+     * Execute command
+     *
+     * @param {string} id Command ID
+     * @param {object} params Command parameters
+     * @param {IExecutionOptions} options Command execution options
+     * @returns {Promise<R>} Command execution result
+     */
+    executeCommand<P extends object = object, R = boolean>(id: string, params?: P, options?: IExecutionOptions): Promise<R>;
+    /**
+     * Get hooks.
+     *
+     * @returns {FHooks} FHooks instance
+     */
+    getHooks(): FHooks;
+}