@univerjs/sheets-ui 0.5.3 → 0.5.4

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

@@ -1,36 +1,32 @@
 import { IDisposable, Nullable } from '@univerjs/core';
-import { ICellPosWithEvent, IHoverRichTextInfo, IHoverRichTextPosition, IScrollState } from '@univerjs/sheets-ui';
+import { IMouseEvent, IPointerEvent } from '@univerjs/engine-render';
+import { ICellPosWithEvent, IDragCellPosition, IHoverRichTextInfo, IHoverRichTextPosition, IScrollState } from '@univerjs/sheets-ui';
 import { FWorkbook } from '@univerjs/sheets/facade';
 import { IDialogPartMethodOptions, ISidebarMethodOptions } from '@univerjs/ui';
+import { ICellEventParam, IFSheetsUIEventParamConfig } from './f-event';
 export interface IFWorkbookSheetsUIMixin {
     /**
      * Open a sidebar.
-     *
      * @deprecated
-     *
      * @param params the sidebar options
      * @returns the disposable object
      */
     openSiderbar(params: ISidebarMethodOptions): IDisposable;
     /**
      * Open a dialog.
-     *
      * @deprecated
-     *
      * @param dialog the dialog options
      * @returns the disposable object
      */
     openDialog(dialog: IDialogPartMethodOptions): IDisposable;
     /**
      * Subscribe to cell click events
-     *
      * @param callback - The callback function to be called when a cell is clicked
      * @returns A disposable object that can be used to unsubscribe from the event
      */
     onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable;
     /**
      * Subscribe cell hover events
-     *
      * @param callback - The callback function to be called when a cell is hovered
      * @returns A disposable object that can be used to unsubscribe from the event
      */
@@ -39,82 +35,101 @@ export interface IFWorkbookSheetsUIMixin {
      * Subscribe to pointer move events on workbook. Just like onCellHover, but with event information.
      * @param {function(ICellPosWithEvent): any} callback The callback function accept cell location and event.
      */
-    onPointerMove(callback: (cell: Nullable<ICellPosWithEvent>, buttons: number) => void): IDisposable;
+    onCellPointerMove(callback: (cell: ICellPosWithEvent, event: IPointerEvent | IMouseEvent) => void): IDisposable;
     /**
      * Subscribe to cell pointer down events.
      * @param {function(ICellPosWithEvent): any} callback The callback function accept cell location and event.
      */
-    onCellPointerDown(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
+    onCellPointerDown(callback: (cell: ICellPosWithEvent) => void): IDisposable;
     /**
      * Subscribe to cell pointer up events.
      * @param {function(ICellPosWithEvent): any} callback The callback function accept cell location and event.
      */
-    onCellPointerUp(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
+    onCellPointerUp(callback: (cell: ICellPosWithEvent) => void): IDisposable;
+    onDragOver(callback: (cell: IDragCellPosition) => void): IDisposable;
+    onDrop(callback: (cell: IDragCellPosition) => void): IDisposable;
     /**
      * Start the editing process
      * @returns A boolean value
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook().startEditing();
+     * ```
      */
     startEditing(): boolean;
     /**
      * Use endEditingAsync as instead
      * @deprecated
+     * End the editing process
+     * @async
+     * @param save - Whether to save the changes
+     * @returns A promise that resolves to a boolean value
+     * @example
+     * ``` ts
+     * univerAPI.getActiveWorkbook().endEditing(true);
+     * ```
      */
     endEditing(save?: boolean): Promise<boolean>;
     /**
      * @async
-     * @param save - Whether to save the changes, default is true
-     * @returns A promise that resolves to a boolean value
-     * @param save
+     * @param {boolean} save - Whether to save the changes, default is true
+     * @returns {Promise<boolean>} A promise that resolves to a boolean value
      */
     endEditingAsync(save?: boolean): Promise<boolean>;
     getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>;
     /**
      * Disable selection. After disabled, there would be no response for selection.
+     * @returns {FWorkbook} FWorkbook instance
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().disableSelection();
      * ```
      */
-    disableSelection(): void;
+    disableSelection(): FWorkbook;
     /**
      * Enable selection. After this you can select range.
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().enableSelection();
      * ```
      */
-    enableSelection(): void;
+    enableSelection(): FWorkbook;
     /**
      * Set selection invisible, Unlike disableSelection, selection still works, you just can not see them.
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().transparentSelection();
      * ```
      */
-    transparentSelection(): void;
+    transparentSelection(): FWorkbook;
     /**
      * Set selection visible.
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook().showSelection();
      * ```
      */
-    showSelection(): void;
+    showSelection(): FWorkbook;
 }
 export declare class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheetsUIMixin {
     openSiderbar(params: ISidebarMethodOptions): IDisposable;
     openDialog(dialog: IDialogPartMethodOptions): IDisposable;
     private _logDeprecation;
+    addUIEvent(event: keyof IFSheetsUIEventParamConfig, _callback: (params: IFSheetsUIEventParamConfig[typeof event]) => void): IDisposable;
+    generateCellParams(cell: IHoverRichTextPosition | ICellPosWithEvent): ICellEventParam;
     onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable;
     onCellHover(callback: (cell: IHoverRichTextPosition) => void): IDisposable;
-    onCellPointerDown(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
-    onCellPointerUp(callback: (cell: Nullable<ICellPosWithEvent>) => void): IDisposable;
-    onPointerMove(callback: (cell: Nullable<ICellPosWithEvent>, buttons: number) => void): IDisposable;
+    onCellPointerDown(callback: (cell: ICellPosWithEvent) => void): IDisposable;
+    onCellPointerUp(callback: (cell: ICellPosWithEvent) => void): IDisposable;
+    onCellPointerMove(callback: (cell: ICellPosWithEvent, event: IPointerEvent | IMouseEvent) => void): IDisposable;
+    onDragOver(callback: (cell: IDragCellPosition) => void): IDisposable;
+    onDrop(callback: (cell: IDragCellPosition) => void): IDisposable;
     startEditing(): boolean;
     endEditing(save?: boolean): Promise<boolean>;
     endEditingAsync(save?: boolean): Promise<boolean>;
     /**
      * Get scroll state of specified sheet.
+     * @param {string} sheetId - sheet id
      * @returns {IScrollState} scroll state
      * @example
      * ``` ts
@@ -122,10 +137,10 @@ export declare class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkb
      * ```
      */
     getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>;
-    disableSelection(): void;
-    enableSelection(): void;
-    transparentSelection(): void;
-    showSelection(): void;
+    disableSelection(): FWorkbook;
+    enableSelection(): FWorkbook;
+    transparentSelection(): FWorkbook;
+    showSelection(): FWorkbook;
 }
 declare module '@univerjs/sheets/facade' {
     interface FWorkbook extends IFWorkbookSheetsUIMixin {

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

@@ -5,7 +5,7 @@ export interface IFWorksheetSkeletonMixin {
     /**
      * Refresh the canvas.
      */
-    refreshCanvas(): void;
+    refreshCanvas(): FWorksheet;
     /**
      * Set zoom ratio of the worksheet.
      * @param {number} zoomRatio The zoom ratio to set.It should be in the range of 10 to 400.
@@ -34,15 +34,27 @@ export interface IFWorksheetSkeletonMixin {
     getZoom(): number;
     /**
      * Return visible range, sum view range of 4 viewports.
-     * @returns IRange
+     * @returns {IRange} - visible range
+     * @example
+     * ``` ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const visibleRange = fWorksheet.getVisibleRange();
+     * ```
      */
     getVisibleRange(): IRange;
     /**
-     * Scroll spreadsheet to cell position. Based on the limitations of viewport and the number of rows and columns, you can only scroll to the maximum scrollable range.
-     * @param row
-     * @param column
+     * Scroll spreadsheet(viewMain) to cell position. Make the cell at topleft of current viewport.
+     * Based on the limitations of viewport and the number of rows and columns, you can only scroll to the maximum scrollable range.
+     * @param {number} row - Cell row index
+     * @param {number} column - Cell column index
+     * @returns {FWorksheet} - Current worksheet
+     * @example
+     * ``` ts
+     * univerAPI.getActiveWorkbook().getActiveSheet().scrollToCell(1, 1);
+     * ```
      */
-    scrollToCell(row: number, column: number): void;
+    scrollToCell(row: number, column: number): FWorksheet;
     /**
      * Get scroll state of current sheet.
      * @returns {IScrollState} curr scroll state
@@ -51,10 +63,11 @@ export interface IFWorksheetSkeletonMixin {
      * univerAPI.getActiveWorkbook().getActiveSheet().getScrollState()
      * ```
      */
-    getScrollState(): Nullable<IScrollState>;
+    getScrollState(): IScrollState;
     /**
      * Invoked when scrolling the sheet.
-     * @param {function(params: Nullable<IViewportScrollState>): void} callback The scrolling callback function.
+     * @param {function(Nullable<IViewportScrollState>): void} callback The scrolling callback function.
+     * @returns {IDisposable} The disposable object to remove the event listener.
      * @example
      * ``` ts
      * univerAPI.getActiveWorkbook().getActiveSheet().onScroll((params) => {...})
@@ -63,12 +76,12 @@ export interface IFWorksheetSkeletonMixin {
     onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable;
 }
 export declare class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSkeletonMixin {
-    refreshCanvas(): void;
+    refreshCanvas(): FWorksheet;
     zoom(zoomRatio: number): FWorksheet;
     getZoom(): number;
     getVisibleRange(): IRange;
-    scrollToCell(row: number, column: number): void;
-    getScrollState(): Nullable<IScrollState>;
+    scrollToCell(row: number, column: number): FWorksheet;
+    getScrollState(): IScrollState;
     onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable;
 }
 declare module '@univerjs/sheets/facade' {

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

@@ -18,8 +18,10 @@ import './f-workbook';
 import './f-worksheet';
 import './f-permission';
 import './f-sheet-hooks';
-export { type IFComponentKey, transformComponentKey } from './f-range';
+import './f-event';
+export type * from './f-event';
 export type * from './f-permission';
+export { type IFComponentKey, transformComponentKey } from './f-range';
 export type * from './f-sheet-hooks';
 export type * from './f-univer';
 export type * from './f-workbook';

package/lib/types/index.d.ts

@@ -15,23 +15,14 @@
  */
 import './global.css';
 export { getEditorObject } from './basics/editor/get-editor-object';
-export { EMBEDDING_FORMULA_EDITOR_COMPONENT_KEY, RANGE_SELECTOR_COMPONENT_KEY, SHEET_VIEW_KEY } from './common/keys';
 export { useActiveWorkbook, useActiveWorksheet, useWorkbooks } from './components/hook';
 export { SHEET_UI_PLUGIN_NAME } from './consts/plugin-name';
 export { SheetsUIPart } from './consts/ui-name';
 export { AutoFillController } from './controllers/auto-fill.controller';
-export { AFFECT_LAYOUT_STYLES, AutoHeightController } from './controllers/auto-height.controller';
-export { AutoWidthController } from './controllers/auto-width.controller';
 export { CellCustomRenderController } from './controllers/cell-custom-render.controller';
-export { type IUniverSheetsUIConfig } from './controllers/config.schema';
-export { DragRenderController } from './controllers/drag-render.controller';
 export { EditingRenderController } from './controllers/editor/editing.render-controller';
-export { FormulaEditorController } from './controllers/editor/formula-editor.controller';
-export { HoverRenderController } from './controllers/hover-render.controller';
 export { PASTE_SPECIAL_MENU_ID, SheetMenuPosition } from './controllers/menu/menu';
 export { deriveStateFromActiveSheet$, getCurrentExclusiveRangeInterest$, getCurrentRangeDisable$, getObservableWithExclusiveRange$ } from './controllers/menu/menu-util';
-export { SheetPermissionInitController } from './controllers/permission/sheet-permission-init.controller';
-export { SheetPermissionInterceptorBaseController } from './controllers/permission/sheet-permission-interceptor-base.controller';
 export { HeaderFreezeRenderController } from './controllers/render-controllers/freeze.render-controller';
 export { HeaderMoveRenderController } from './controllers/render-controllers/header-move.render-controller';
 export { HeaderResizeRenderController } from './controllers/render-controllers/header-resize.render-controller';
@@ -39,10 +30,7 @@ export { SheetsScrollRenderController } from './controllers/render-controllers/s
 export { SheetRenderController } from './controllers/render-controllers/sheet.render-controller';
 export { SheetUIController } from './controllers/sheet-ui.controller';
 export { whenFormulaEditorActivated, whenSheetEditorFocused } from './controllers/shortcuts/utils';
-export { StatusBarController } from './controllers/status-bar.controller';
 export { getCoordByCell, getCoordByOffset, getSheetObject, getTransformCoord, } from './controllers/utils/component-tools';
-export { discreteRangeToRange, rangeToDiscreteRange, virtualizeDiscreteRanges } from './controllers/utils/range-tools';
-export type { IDiscreteRange } from './controllers/utils/range-tools';
 export { matchedSelectionByRowColIndex as checkInHeaderRanges } from './controllers/utils/selections-tools';
 export { useHighlightRange } from './hooks/useHighlightRange';
 export { UniverSheetsMobileUIPlugin } from './mobile-plugin';
@@ -55,7 +43,7 @@ export { type ICanvasPopup, SheetCanvasPopManagerService } from './services/canv
 export { CellAlertManagerService, CellAlertType, type ICellAlert } from './services/cell-alert-manager.service';
 export { getMatrixPlainText, ISheetClipboardService, PREDEFINED_HOOK_NAME, SheetClipboardService, } from './services/clipboard/clipboard.service';
 export { COPY_TYPE } from './services/clipboard/type';
-export type { ICellDataWithSpanInfo, ICopyPastePayload, ISheetClipboardHook, ISheetDiscreteRangeLocation } from './services/clipboard/type';
+export type { ICellDataWithSpanInfo, ICopyPastePayload, IPasteHookValueType, ISheetClipboardHook, ISheetDiscreteRangeLocation } from './services/clipboard/type';
 export { getRepeatRange, mergeSetRangeValues } from './services/clipboard/utils';
 export { DragManagerService, type IDragCellPosition } from './services/drag-manager.service';
 export { EditorBridgeService, IEditorBridgeService, type IEditorBridgeServiceVisibleParam, } from './services/editor-bridge.service';
@@ -65,6 +53,16 @@ export { IFormulaEditorManagerService } from './services/editor/formula-editor-m
 export { HoverManagerService } from './services/hover-manager.service';
 export type { ICellPosWithEvent, IHoverCellPosition, IHoverRichTextInfo, IHoverRichTextPosition } from './services/hover-manager.service';
 export { IMarkSelectionService, MarkSelectionService } from './services/mark-selection/mark-selection.service';
+export { HoverRenderController } from './controllers/hover-render.controller';
+export { DragRenderController } from './controllers/drag-render.controller';
+export { EMBEDDING_FORMULA_EDITOR_COMPONENT_KEY, RANGE_SELECTOR_COMPONENT_KEY, SHEET_VIEW_KEY } from './common/keys';
+export type { IDiscreteRange } from './controllers/utils/range-tools';
+export { discreteRangeToRange, rangeToDiscreteRange, virtualizeDiscreteRanges } from './controllers/utils/range-tools';
+export { AFFECT_LAYOUT_STYLES, AutoHeightController } from './controllers/auto-height.controller';
+export { AutoWidthController } from './controllers/auto-width.controller';
+export { FormulaEditorController } from './controllers/editor/formula-editor.controller';
+export { StatusBarController } from './controllers/status-bar.controller';
+export { SheetPermissionCheckUIController } from './controllers/permission/sheet-permission-check-ui.controller';
 export { SheetPermissionUserManagerService } from './services/permission/sheet-permission-user-list.service';
 export { SheetPrintInterceptorService } from './services/print-interceptor.service';
 export { SheetScrollManagerService } from './services/scroll-manager.service';
@@ -82,6 +80,7 @@ export { MobileSheetBar } from './views/mobile/sheet-bar/MobileSheetBar';
 export type { IRangeProtectionRenderCellData } from './views/permission/extensions/range-protection.render';
 export { SheetBar } from './views/sheet-bar/SheetBar';
 export { RenderSheetContent, RenderSheetFooter, RenderSheetHeader } from './views/sheet-container/SheetContainer';
+export { type IUniverSheetsUIConfig } from './controllers/config.schema';
 export { getCellRealRange } from './common/utils';
 export { FONT_FAMILY_COMPONENT, FONT_FAMILY_ITEM_COMPONENT } from './components/font-family/interface';
 export { FONT_SIZE_COMPONENT } from './components/font-size/interface';
@@ -94,7 +93,7 @@ export type { IFormatPainterBeforeApplyHookParams, IFormatPainterHook } from './
 export { SELECTION_SHAPE_DEPTH } from './services/selection/const';
 export { type IBaseSheetBarProps } from './views/sheet-bar/sheet-bar-tabs/SheetBarItem';
 export { AutoClearContentCommand, AutoFillCommand } from './commands/commands/auto-fill.command';
-export { type ISheetPasteParams, SheetCopyCommand, SheetCutCommand, SheetPasteBesidesBorderCommand, SheetPasteColWidthCommand, SheetPasteCommand, SheetPasteFormatCommand, SheetPasteShortKeyCommand, SheetPasteValueCommand, } from './commands/commands/clipboard.command';
+export { type ISheetPasteByShortKeyParams, type ISheetPasteParams, SheetCopyCommand, SheetCutCommand, SheetPasteBesidesBorderCommand, SheetPasteColWidthCommand, SheetPasteCommand, SheetPasteFormatCommand, SheetPasteShortKeyCommand, SheetPasteValueCommand, } from './commands/commands/clipboard.command';
 export { DeleteRangeMoveLeftConfirmCommand } from './commands/commands/delete-range-move-left-confirm.command';
 export { DeleteRangeMoveUpConfirmCommand } from './commands/commands/delete-range-move-up-confirm.command';
 export { HideColConfirmCommand, HideRowConfirmCommand } from './commands/commands/hide-row-col-confirm.command';

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

@@ -1,19 +1,20 @@
 import { ICellDataWithSpanAndDisplay, IDisposable, IRange, Nullable, Disposable, ErrorService, ICommandService, ILogService, Injector, IUndoRedoService, IUniverInstanceService, LocaleService, ObjectMatrix, ThemeService } from '@univerjs/core';
+import { Observable } from 'rxjs';
 import { IDiscreteRange } from '../../controllers/utils/range-tools';
-import { ISheetClipboardHook, COPY_TYPE } from './type';
+import { IPasteHookKeyType, IPasteOptionCache, ISheetClipboardHook, COPY_TYPE } from './type';
 import { IRenderManagerService } from '@univerjs/engine-render';
 import { SheetsSelectionsService } from '@univerjs/sheets';
 import { IClipboardInterfaceService, INotificationService, IPlatformService } from '@univerjs/ui';
 import { IMarkSelectionService } from '../mark-selection/mark-selection.service';
 import { CopyContentCache } from './copy-content-cache';
 export declare const PREDEFINED_HOOK_NAME: {
-    DEFAULT_COPY: string;
-    DEFAULT_PASTE: string;
-    SPECIAL_PASTE_VALUE: string;
-    SPECIAL_PASTE_FORMAT: string;
-    SPECIAL_PASTE_COL_WIDTH: string;
-    SPECIAL_PASTE_BESIDES_BORDER: string;
-    SPECIAL_PASTE_FORMULA: string;
+    readonly DEFAULT_COPY: "default-copy";
+    readonly DEFAULT_PASTE: "default-paste";
+    readonly SPECIAL_PASTE_VALUE: "special-paste-value";
+    readonly SPECIAL_PASTE_FORMAT: "special-paste-format";
+    readonly SPECIAL_PASTE_COL_WIDTH: "special-paste-col-width";
+    readonly SPECIAL_PASTE_BESIDES_BORDER: "special-paste-besides-border";
+    readonly SPECIAL_PASTE_FORMULA: "special-paste-formula";
 };
 interface ICopyContent {
     copyId: string;
@@ -23,10 +24,16 @@ interface ICopyContent {
     discreteRange: IDiscreteRange;
 }
 export interface ISheetClipboardService {
+    showMenu$: Observable<boolean>;
+    setShowMenu: (show: boolean) => void;
+    pasteOptionsCache$: Observable<IPasteOptionCache | null>;
+    updatePasteOptionsCache(cache: IPasteOptionCache | null): void;
     copy(): Promise<boolean>;
     cut(): Promise<boolean>;
     paste(item: ClipboardItem, pasteType?: string): Promise<boolean>;
     legacyPaste(html?: string, text?: string): Promise<boolean>;
+    rePasteWithPasteType(type: IPasteHookKeyType): boolean;
+    disposePasteOptionsCache(): void;
     generateCopyContent(workbookId: string, worksheetId: string, range: IRange): Nullable<ICopyContent>;
     copyContentCache(): CopyContentCache;
     addClipboardHook(hook: ISheetClipboardHook): IDisposable;
@@ -51,18 +58,25 @@ export declare class SheetClipboardService extends Disposable implements ISheetC
     private readonly _injector;
     private _clipboardHooks;
     private readonly _clipboardHooks$;
-    readonly clipboardHooks$: import('rxjs').Observable<ISheetClipboardHook[]>;
+    readonly clipboardHooks$: Observable<ISheetClipboardHook[]>;
     private _htmlToUSM;
     private _usmToHtml;
     private _copyContentCache;
     private _copyMarkId;
+    private _pasteOptionsCache$;
+    readonly pasteOptionsCache$: Observable<IPasteOptionCache | null>;
+    private readonly _showMenu$;
+    readonly showMenu$: Observable<boolean>;
     constructor(_logService: ILogService, _univerInstanceService: IUniverInstanceService, _selectionManagerService: SheetsSelectionsService, _clipboardInterfaceService: IClipboardInterfaceService, _undoRedoService: IUndoRedoService, _commandService: ICommandService, _markSelectionService: IMarkSelectionService, _notificationService: INotificationService, _platformService: IPlatformService, _renderManagerService: IRenderManagerService, _themeService: ThemeService, _localeService: LocaleService, _errorService: ErrorService, _injector: Injector);
+    setShowMenu(show: boolean): void;
     copyContentCache(): CopyContentCache;
     generateCopyContent(workbookId: string, worksheetId: string, range: IRange): Nullable<ICopyContent>;
     copy(copyType?: COPY_TYPE): Promise<boolean>;
     cut(): Promise<boolean>;
-    paste(item: ClipboardItem, pasteType?: string): Promise<boolean>;
+    paste(item: ClipboardItem, pasteType?: "default-paste"): Promise<boolean>;
     legacyPaste(html?: string, text?: string): Promise<boolean>;
+    rePasteWithPasteType(type: IPasteHookKeyType): boolean;
+    updatePasteOptionsCache(cache: IPasteOptionCache | null): void;
     addClipboardHook(hook: ISheetClipboardHook): IDisposable;
     getClipboardHooks(): ISheetClipboardHook[];
     private _generateCopyContent;
@@ -127,6 +141,7 @@ export declare class SheetClipboardService extends Disposable implements ISheetC
     private _topLeftCellsMatch;
     removeMarkSelection(): void;
     private _initUnitDisposed;
+    disposePasteOptionsCache(): void;
 }
 export declare function getMatrixPlainText(matrix: ObjectMatrix<ICellDataWithSpanAndDisplay>): string;
 export declare const escapeSpecialCode: (cellStr: string) => string;

package/lib/types/services/clipboard/type.d.ts

@@ -1,5 +1,6 @@
 import { ICellData, IDocumentData, IMutationInfo, IRange, ObjectMatrix } from '@univerjs/core';
 import { IDiscreteRange } from '../../controllers/utils/range-tools';
+import { PREDEFINED_HOOK_NAME } from './clipboard.service';
 export declare enum COPY_TYPE {
     COPY = "COPY",
     CUT = "CUT"
@@ -30,7 +31,7 @@ export interface IParsedCellValueByClipboard {
 }
 export interface IUniverSheetCopyDataModel {
     rowProperties?: IClipboardPropertyItem[];
-    colProperties?: IClipboardPropertyItem[] | null;
+    colProperties?: IClipboardPropertyItem[];
     cellMatrix: ObjectMatrix<ICellDataWithSpanInfo>;
 }
 export interface IPasteTarget {
@@ -41,7 +42,7 @@ export interface IPasteTarget {
 export interface ICopyPastePayload {
     copyType?: COPY_TYPE;
     copyId?: string;
-    pasteType: string;
+    pasteType: IPasteHookValueType;
 }
 export interface ISheetDiscreteRangeLocation {
     range: IDiscreteRange;
@@ -133,3 +134,18 @@ export interface ISheetClipboardHook {
      */
     getFilteredOutRows?(range: IRange): number[];
 }
+export interface IPasteOptionCache {
+    target: IPasteTarget;
+    source?: IPasteSource;
+    cellMatrix: ObjectMatrix<ICellDataWithSpanInfo>;
+    rowProperties?: IClipboardPropertyItem[];
+    colProperties?: IClipboardPropertyItem[];
+    pasteType: IPasteHookValueType;
+}
+export type IPasteSource = ISheetDiscreteRangeLocation & {
+    copyId: string;
+    copyType: COPY_TYPE;
+};
+export type IPasteHookKeyType = Exclude<keyof typeof PREDEFINED_HOOK_NAME, 'default-copy'>;
+export type IPasteHookValueTypeWithoutDefaultCopy = typeof PREDEFINED_HOOK_NAME[IPasteHookKeyType];
+export type IPasteHookValueType = Exclude<IPasteHookValueTypeWithoutDefaultCopy, 'default-copy'>;

package/lib/types/services/hover-manager.service.d.ts

@@ -77,6 +77,12 @@ export declare class HoverManagerService extends Disposable {
     triggerPointerDown(unitId: string, event: IPointerEvent | IMouseEvent): void;
     triggerPointerUp(unitId: string, event: IPointerEvent | IMouseEvent): void;
     triggerMouseMove(unitId: string, event: IPointerEvent | IMouseEvent): void;
+    /**
+     * Trigger by pointerup.
+     * @param unitId
+     * @param offsetX
+     * @param offsetY
+     */
     triggerClick(unitId: string, offsetX: number, offsetY: number): void;
     triggerScroll(): void;
 }

package/lib/types/services/scroll-manager.service.d.ts

@@ -12,11 +12,19 @@ export interface IScrollState {
      */
     offsetY: number;
     /**
-     * current start row in viewport visible area
+     * Current start row in viewportMain in canvas, NOT the first row of visible area of current viewport after freeze.
+     * e.g. If no freeze, it's the same as startRow in current viewport.
+     * If freeze, this value is smaller than the first row of visible area.  Just pretend that viewMainTop does not exist.
+     *
+     * e.g. If row 1 ~ 2 is frozen, the first row if viewMain is 3, but sheetViewStartRow still 0.
      */
     sheetViewStartRow: number;
     /**
-     * current start column in viewport visible area
+     * Current start column in viewportMain in canvas, NOT the first column of visible area of current viewport after freeze.
+     * e.g. If no freeze, it's the same as startColumn in current viewport.
+     * If freeze, this value is smaller than the first column of visible area.  Just pretend that viewMainLeft does not exist.
+     *
+     * e.g. If column A ~ C is frozen, the first column of viewMain is D, but sheetViewStartColumn still 0.
      */
     sheetViewStartColumn: number;
 }

package/lib/types/services/selection/base-selection-render.service.d.ts

@@ -126,9 +126,9 @@ export declare class BaseSelectionRenderService extends Disposable implements IS
     setSingleSelectionEnabled(enabled?: boolean): void;
     newSelectionControl(scene: Scene, skeleton: SpreadsheetSkeleton, selection: ISelectionWithStyle): SelectionControl;
     /**
-     * Update the corresponding selectionControl based on selectionsData.
-     * selectionData[i] syncs selectionControls[i]
-     * @param selectionsWithCoord
+     * Update the corresponding selectionControl based on selectionsData from WorkbookSelectionModel
+     * selectionData[i] --> selectionControls[i]
+     * @param selectionsWithStyleList {ISelectionWithStyle[]} selectionsData from WorkbookSelectionModel
      */
     resetSelectionsByModelData(selectionsWithStyleList: readonly ISelectionWithStyle[]): void;
     refreshSelectionMoveStart(): void;

package/lib/types/services/selection/selection-render.service.d.ts

@@ -33,6 +33,10 @@ export declare class SheetSelectionRenderService extends BaseSelectionRenderServ
     private _initUserActionSyncListener;
     /**
      * Update selectionData to selectionDataModel (WorkBookSelections) by SetSelectionsOperation.
+     *
+     * Unlike baseSelectionRenderService@resetSelectionsByModelData, this method is for update WorkbookSelectionModel.
+     *
+     *
      * @param selectionDataWithStyleList
      * @param type
      */

package/lib/types/views/cell-alert/CellAlertPopup.d.ts

@@ -1,5 +1,10 @@
-import { default as React } from 'react';
 import { ICanvasPopup } from '../../services/canvas-pop-manager.service';
+import { default as React } from 'react';
+/**
+ *
+ * @param root0
+ * @param root0.popup
+ */
 export declare function CellAlert({ popup }: {
     popup: ICanvasPopup;
 }): React.JSX.Element | null;

package/lib/types/views/clipboard/ClipboardPopupMenu.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const ClipboardPopupMenu: () => React.JSX.Element | null;

package/lib/umd/facade.js

@@ -1 +1 @@
-(function(a,i){typeof exports=="object"&&typeof module<"u"?i(exports,require("@univerjs/core"),require("@univerjs/engine-render"),require("@univerjs/sheets-ui"),require("@univerjs/sheets/facade"),require("@univerjs/ui"),require("rxjs"),require("@univerjs/sheets")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core","@univerjs/engine-render","@univerjs/sheets-ui","@univerjs/sheets/facade","@univerjs/ui","rxjs","@univerjs/sheets"],i):(a=typeof globalThis<"u"?globalThis:a||self,i(a.UniverSheetsUiFacade={},a.UniverCore,a.UniverEngineRender,a.UniverSheetsUi,a.UniverSheetsFacade,a.UniverUi,a.rxjs,a.UniverSheets))})(this,function(a,i,c,o,l,S,v,m){"use strict";class I extends i.FUniver{customizeColumnHeader(e){const t=this.getActiveWorkbook();if(!t){console.error("WorkBook not exist");return}const r=t==null?void 0:t.getId();this._getSheetRenderComponent(r,o.SHEET_VIEW_KEY.COLUMN).setCustomHeader(e)}customizeRowHeader(e){const t=this.getActiveWorkbook();if(!t){console.error("WorkBook not exist");return}const r=t==null?void 0:t.getId();this._getSheetRenderComponent(r,o.SHEET_VIEW_KEY.ROW).setCustomHeader(e)}registerSheetRowHeaderExtension(e,...t){const r=this._getSheetRenderComponent(e,o.SHEET_VIEW_KEY.ROW),n=r.register(...t);return i.toDisposable(()=>{n.dispose(),r.makeDirty(!0)})}registerSheetColumnHeaderExtension(e,...t){const r=this._getSheetRenderComponent(e,o.SHEET_VIEW_KEY.COLUMN),n=r.register(...t);return i.toDisposable(()=>{n.dispose(),r.makeDirty(!0)})}registerSheetMainExtension(e,...t){const r=this._getSheetRenderComponent(e,o.SHEET_VIEW_KEY.MAIN),n=r.register(...t);return i.toDisposable(()=>{n.dispose(),r.makeDirty(!0)})}_getSheetRenderComponent(e,t){const n=this._injector.get(c.IRenderManagerService).getRenderById(e);if(!n)throw new Error(`Render Unit with unitId ${e} not found`);const{components:s}=n,d=s.get(t);if(!d)throw new Error("Render component not found");return d}getSheetHooks(){return this._injector.createInstance(l.FSheetHooks)}}i.FUniver.extend(I);class C extends l.FWorkbook{openSiderbar(e){return this._logDeprecation("openSiderbar"),this._injector.get(S.ISidebarService).open(e)}openDialog(e){this._logDeprecation("openDialog");const r=this._injector.get(S.IDialogService).open({...e,onClose:()=>{r.dispose()}});return r}_logDeprecation(e){this._injector.get(i.ILogService).warn("[FWorkbook]",`${e} is deprecated. Please use the function of the same name on "FUniver".`)}onCellClick(e){const t=this._injector.get(o.HoverManagerService);return i.toDisposable(t.currentClickedCell$.pipe(v.filter(r=>!!r)).subscribe(e))}onCellHover(e){const t=this._injector.get(o.HoverManagerService);return i.toDisposable(t.currentRichText$.pipe(v.filter(r=>!!r)).subscribe(e))}onCellPointerDown(e){const t=this._injector.get(o.HoverManagerService);return i.toDisposable(t.currentPointerDownCell$.subscribe(e))}onCellPointerUp(e){const t=this._injector.get(o.HoverManagerService);return i.toDisposable(t.currentPointerUpCell$.subscribe(e))}onPointerMove(e){const t=this._injector.get(o.HoverManagerService);return i.toDisposable(t.currentCellPosWithEvent$.pipe(v.filter(r=>!!r)).subscribe(r=>{e(r,r.event.buttons)}))}startEditing(){return this._injector.get(i.ICommandService).syncExecuteCommand(o.SetCellEditVisibleOperation.id,{eventType:c.DeviceInputEventType.Dblclick,unitId:this._workbook.getUnitId(),visible:!0})}async endEditing(e){return this._injector.get(i.ICommandService).syncExecuteCommand(o.SetCellEditVisibleOperation.id,{eventType:c.DeviceInputEventType.Keyboard,keycode:e?S.KeyCode.ENTER:S.KeyCode.ESC,visible:!1,unitId:this._workbook.getUnitId()}),await i.awaitTime(0),!0}endEditingAsync(e=!0){return this.endEditing(e)}getScrollStateBySheetId(e){const t=this._workbook.getUnitId(),n=this._injector.get(c.IRenderManagerService).getRenderById(t);return n?n.with(o.SheetScrollManagerService).getScrollStateByParam({unitId:t,sheetId:e}):null}disableSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(c.IRenderManagerService).getRenderById(e);r&&r.with(o.ISheetSelectionRenderService).disableSelection()}enableSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(c.IRenderManagerService).getRenderById(e);r&&r.with(o.ISheetSelectionRenderService).enableSelection()}transparentSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(c.IRenderManagerService).getRenderById(e);r&&r.with(o.ISheetSelectionRenderService).transparentSelection()}showSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(c.IRenderManagerService).getRenderById(e);r&&r.with(o.ISheetSelectionRenderService).showSelection()}}l.FWorkbook.extend(C);class _ extends l.FWorksheet{refreshCanvas(){const e=this._injector.get(c.IRenderManagerService),t=this._fWorkbook.id,r=e.getRenderById(t);if(!r)throw new Error(`Render Unit with unitId ${t} not found`);r.with(o.SheetSkeletonManagerService).reCalculate();const n=r.mainComponent;if(!n)throw new Error("Main component not found");n.makeDirty()}zoom(e){return this._injector.get(i.ICommandService).syncExecuteCommand(o.ChangeZoomRatioCommand.id,{unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),zoomRatio:e}),this}getZoom(){return this._worksheet.getZoomRatio()}getVisibleRange(){const e=this._workbook.getUnitId(),r=this._injector.get(c.IRenderManagerService).getRenderById(e);let n={startColumn:0,startRow:0,endColumn:0,endRow:0};if(!r)return n;const d=r.with(o.SheetSkeletonManagerService).getCurrentSkeleton();if(!d)return n;const h=d==null?void 0:d.getVisibleRanges();if(!h)return n;n=d.getVisibleRangeByViewport(c.SHEET_VIEWPORT_KEY.VIEW_MAIN);for(const[w,u]of h)c.sheetContentViewportKeys.indexOf(w)!==-1&&(n.startColumn=Math.min(n.startColumn,u.startColumn),n.startRow=Math.min(n.startRow,u.startRow),n.endColumn=Math.max(n.endColumn,u.endColumn),n.endRow=Math.max(n.endRow,u.endRow));return n}scrollToCell(e,t){const r=this._workbook.getUnitId(),s=this._injector.get(c.IRenderManagerService).getRenderById(r);s&&(s==null?void 0:s.with(o.SheetsScrollRenderController)).scrollToCell(e,t)}getScrollState(){const e=this._workbook.getUnitId(),t=this._worksheet.getSheetId(),n=this._injector.get(c.IRenderManagerService).getRenderById(e);return n?n.with(o.SheetScrollManagerService).getScrollStateByParam({unitId:e,sheetId:t}):null}onScroll(e){var s;const t=this._workbook.getUnitId(),n=(s=this._injector.get(c.IRenderManagerService).getRenderById(t))==null?void 0:s.with(o.SheetScrollManagerService);if(n){const d=n.validViewportScrollInfo$.subscribe(h=>{e(h)});return i.toDisposable(d)}return i.toDisposable(()=>{})}}l.FWorksheet.extend(_);class k extends l.FPermission{setPermissionDialogVisible(e){this._permissionService.setShowComponents(e)}}l.FPermission.extend(k);class b extends l.FSheetHooks{onCellPointerMove(e){return i.toDisposable(this._injector.get(o.HoverManagerService).currentPosition$.subscribe(e))}onCellPointerOver(e){return i.toDisposable(this._injector.get(o.HoverManagerService).currentCell$.subscribe(e))}onCellDragOver(e){return i.toDisposable(this._injector.get(o.DragManagerService).currentCell$.subscribe(e))}onCellDrop(e){return i.toDisposable(this._injector.get(o.DragManagerService).endCell$.subscribe(e))}onCellRender(e,t=i.InterceptorEffectEnum.Style,r=m.InterceptCellContentPriority.DATA_VALIDATION){return this._injector.get(m.SheetInterceptorService).intercept(m.INTERCEPTOR_POINT.CELL_CONTENT,{effect:t,handler:(n,s,d)=>d({...n,customRender:[...(n==null?void 0:n.customRender)||[],...e||[]]}),priority:r})}onBeforeCellEdit(e){return this._injector.get(i.ICommandService).beforeCommandExecuted(t=>{const r=t.params;t.id===o.SetCellEditVisibleOperation.id&&r.visible&&e(r)})}onAfterCellEdit(e){return this._injector.get(i.ICommandService).onCommandExecuted(t=>{const r=t.params;t.id===o.SetCellEditVisibleOperation.id&&!r.visible&&e(r)})}}l.FSheetHooks.extend(b);class M extends l.FRange{getCell(){const e=this._injector.get(c.IRenderManagerService),t=this._workbook.getUnitId(),r=this._worksheet.getSheetId();return e.getRenderById(t).with(o.SheetSkeletonManagerService).getWorksheetSkeleton(r).skeleton.getCellWithCoordByIndex(this._range.startRow,this._range.startColumn)}getCellRect(){const{startX:e,startY:t,endX:r,endY:n}=this.getCell(),s={x:e,y:t,width:r-e,height:n-t,top:t,left:e,bottom:n,right:r};return{...s,toJSON:()=>JSON.stringify(s)}}generateHTML(){var t;const e=this._injector.get(o.ISheetClipboardService).generateCopyContent(this._workbook.getUnitId(),this._worksheet.getSheetId(),this._range);return(t=e==null?void 0:e.html)!=null?t:""}attachPopup(e){const{key:t,disposableCollection:r}=p(e,this._injector.get(S.ComponentManager)),s=this._injector.get(o.SheetCanvasPopManagerService).attachPopupToCell(this._range.startRow,this._range.startColumn,{...e,componentKey:t},this.getUnitId(),this._worksheet.getSheetId());return s?(r.add(s),r):(r.dispose(),null)}attachAlertPopup(e){const t=this._injector.get(o.CellAlertManagerService),r={workbook:this._workbook,worksheet:this._worksheet,row:this._range.startRow,col:this._range.startColumn,unitId:this.getUnitId(),subUnitId:this._worksheet.getSheetId()};return t.showAlert({...e,location:r}),{dispose:()=>{t.removeAlert(e.key)}}}highlight(e,t){const r=this._injector.get(o.IMarkSelectionService),n=r.addShape({range:this._range,style:e,primary:t});if(!n)throw new Error("Failed to highlight current range");return i.toDisposable(()=>{r.removeShape(n)})}}l.FRange.extend(M);function p(g,e){const{componentKey:t,isVue3:r}=g;let n;const s=new i.DisposableCollection;return typeof t=="string"?n=t:(n=`External_${i.generateRandomId(6)}`,s.add(e.register(n,t,{framework:r?"vue3":"react"}))),{key:n,disposableCollection:s}}a.transformComponentKey=p,Object.defineProperty(a,Symbol.toStringTag,{value:"Module"})});
+(function(h,o){typeof exports=="object"&&typeof module<"u"?o(exports,require("@univerjs/core"),require("@univerjs/docs"),require("@univerjs/engine-render"),require("@univerjs/sheets-ui"),require("@univerjs/sheets/facade"),require("@univerjs/ui"),require("rxjs"),require("@univerjs/sheets")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core","@univerjs/docs","@univerjs/engine-render","@univerjs/sheets-ui","@univerjs/sheets/facade","@univerjs/ui","rxjs","@univerjs/sheets"],o):(h=typeof globalThis<"u"?globalThis:h||self,o(h.UniverSheetsUiFacade={},h.UniverCore,h.UniverDocs,h.UniverEngineRender,h.UniverSheetsUi,h.UniverSheetsFacade,h.UniverUi,h.rxjs,h.UniverSheets))})(this,function(h,o,k,d,s,u,c,f,I){"use strict";class P extends o.FUniver{_initSheetUIEvent(e){const t=e.get(o.ICommandService);this.disposeWithMe(t.beforeCommandExecuted(r=>{if(r.id===s.SetCellEditVisibleOperation.id){if(!this._eventListend(this.Event.BeforeSheetEditStart)&&!this._eventListend(this.Event.BeforeSheetEditEnd))return;const n=this.getCommandSheetTarget(r);if(!n)return;const{workbook:i,worksheet:a}=n,l=e.get(s.IEditorBridgeService),g=e.get(o.IUniverInstanceService),C=r.params,{visible:v,keycode:b,eventType:m}=C,p=l.getEditLocation();if(v){const _={row:p.row,column:p.column,eventType:m,keycode:b,workbook:i,worksheet:a,isZenEditor:!1};if(this.fireEvent(this.Event.BeforeSheetEditStart,_),_.cancel)throw new o.CanceledError}else{const _={row:p.row,column:p.column,eventType:m,keycode:b,workbook:i,worksheet:a,isZenEditor:!1,value:o.RichTextValue.create(g.getUnit(o.DOCS_NORMAL_EDITOR_UNIT_ID_KEY).getSnapshot()),isConfirm:b!==c.KeyCode.ESC};if(this.fireEvent(this.Event.BeforeSheetEditEnd,_),_.cancel)throw new o.CanceledError}}})),this.disposeWithMe(t.onCommandExecuted(r=>{if(r.id===s.SetCellEditVisibleOperation.id){if(!this._eventListend(this.Event.SheetEditStarted)&&!this._eventListend(this.Event.SheetEditEnded))return;const n=this.getCommandSheetTarget(r);if(!n)return;const{workbook:i,worksheet:a}=n,l=e.get(s.IEditorBridgeService),g=r.params,{visible:C,keycode:v,eventType:b}=g,m=l.getEditLocation();if(C){const p={row:m.row,column:m.column,eventType:b,keycode:v,workbook:i,worksheet:a,isZenEditor:!1};this.fireEvent(this.Event.SheetEditStarted,p)}else{const p={row:m.row,column:m.column,eventType:b,keycode:v,workbook:i,worksheet:a,isZenEditor:!1,isConfirm:v!==c.KeyCode.ESC};this.fireEvent(this.Event.SheetEditEnded,p)}}if(r.id===k.RichTextEditingMutation.id){if(!this._eventListend(this.Event.SheetEditChanging))return;const n=this.getCommandSheetTarget(r);if(!n)return;const{workbook:i,worksheet:a}=n,l=e.get(s.IEditorBridgeService),g=e.get(o.IUniverInstanceService),C=r.params;if(!l.isVisible().visible)return;const{unitId:v}=C;if(v===o.DOCS_NORMAL_EDITOR_UNIT_ID_KEY){const{row:b,column:m}=l.getEditLocation(),p={workbook:i,worksheet:a,row:b,column:m,value:o.RichTextValue.create(g.getUnit(o.DOCS_NORMAL_EDITOR_UNIT_ID_KEY).getSnapshot()),isZenEditor:!1};this.fireEvent(this.Event.SheetEditChanging,p)}}}))}_initialize(e){this._initSheetUIEvent(e);const t=e.get(o.ICommandService);this.disposeWithMe(t.beforeCommandExecuted(r=>{switch(r.id){case c.CopyCommand.id:case c.CutCommand.id:this._beforeClipboardChange();break;case s.SheetPasteShortKeyCommand.id:this._beforeClipboardPaste(r.params);break}})),this.disposeWithMe(t.onCommandExecuted(r=>{switch(r.id){case c.CopyCommand.id:case c.CutCommand.id:this._clipboardChanged();break;case s.SheetPasteShortKeyCommand.id:this._clipboardPaste();break;case c.PasteCommand.id:this._clipboardPasteAsync();break}})),this.disposeWithMe(t.beforeCommandExecuted(async r=>{switch(r.id){case c.PasteCommand.id:await this._beforeClipboardPasteAsync();break}}))}_generateClipboardCopyParam(){const e=this.getActiveWorkbook(),t=e==null?void 0:e.getActiveSheet(),r=e==null?void 0:e.getActiveRange();if(!e||!t||!r)return;const i=this._injector.get(s.ISheetClipboardService).generateCopyContent(e.getId(),t.getSheetId(),r.getRange());if(!i)return;const{html:a,plain:l}=i;return{workbook:e,worksheet:t,text:l,html:a,fromSheet:t,fromRange:r}}_beforeClipboardChange(){if(!this.hasEventCallback(this.Event.BeforeClipboardChange))return;const e=this._generateClipboardCopyParam();if(e&&(this.fireEvent(this.Event.BeforeClipboardChange,e),e.cancel))throw new Error("Before clipboard change is canceled")}_clipboardChanged(){if(!this.hasEventCallback(this.Event.ClipboardChanged))return;const e=this._generateClipboardCopyParam();if(e&&(this.fireEvent(this.Event.ClipboardChanged,e),e.cancel))throw new Error("Clipboard changed is canceled")}_generateClipboardPasteParam(e){if(!e)return;const{htmlContent:t,textContent:r}=e,n=this.getActiveWorkbook(),i=n==null?void 0:n.getActiveSheet();return!n||!i?void 0:{workbook:n,worksheet:i,text:r,html:t}}async _generateClipboardPasteParamAsync(){const e=this.getActiveWorkbook(),t=e==null?void 0:e.getActiveSheet();if(!e||!t)return;const i=(await this._injector.get(c.IClipboardInterfaceService).read())[0];let a;if(i){const l=i.types,g=l.indexOf(c.PLAIN_TEXT_CLIPBOARD_MIME_TYPE)!==-1?await i.getType(c.PLAIN_TEXT_CLIPBOARD_MIME_TYPE).then(v=>v&&v.text()):"",C=l.indexOf(c.HTML_CLIPBOARD_MIME_TYPE)!==-1?await i.getType(c.HTML_CLIPBOARD_MIME_TYPE).then(v=>v&&v.text()):"";a={workbook:e,worksheet:t,text:g,html:C}}return a}_beforeClipboardPaste(e){if(!this.hasEventCallback(this.Event.BeforeClipboardPaste))return;const t=this._generateClipboardPasteParam(e);if(t&&(this.fireEvent(this.Event.BeforeClipboardPaste,t),t.cancel))throw new Error("Before clipboard paste is canceled")}_clipboardPaste(e){if(!this.hasEventCallback(this.Event.BeforeClipboardPaste))return;const t=this._generateClipboardPasteParam(e);if(t&&(this.fireEvent(this.Event.BeforeClipboardPaste,t),t.cancel))throw new Error("Clipboard pasted is canceled")}async _beforeClipboardPasteAsync(){if(!this.hasEventCallback(this.Event.BeforeClipboardPaste))return;if(!c.supportClipboardAPI()){this._injector.get(o.ILogService).warn("[Facade]: The navigator object only supports the browser environment");return}const e=await this._generateClipboardPasteParamAsync();if(e&&(this.fireEvent(this.Event.BeforeClipboardPaste,e),e.cancel))throw new Error("Before clipboard paste is canceled")}async _clipboardPasteAsync(){if(!this.hasEventCallback(this.Event.ClipboardPasted))return;if(!c.supportClipboardAPI()){this._injector.get(o.ILogService).warn("[Facade]: The navigator object only supports the browser environment");return}const e=await this._generateClipboardPasteParamAsync();if(e&&(this.fireEvent(this.Event.ClipboardPasted,e),e.cancel))throw new Error("Clipboard pasted is canceled")}customizeColumnHeader(e){const t=this.getActiveWorkbook();if(!t){console.error("WorkBook not exist");return}const r=t==null?void 0:t.getId();this._getSheetRenderComponent(r,s.SHEET_VIEW_KEY.COLUMN).setCustomHeader(e)}customizeRowHeader(e){const t=this.getActiveWorkbook();if(!t){console.error("WorkBook not exist");return}const r=t==null?void 0:t.getId();this._getSheetRenderComponent(r,s.SHEET_VIEW_KEY.ROW).setCustomHeader(e)}registerSheetRowHeaderExtension(e,...t){const r=this._getSheetRenderComponent(e,s.SHEET_VIEW_KEY.ROW),n=r.register(...t);return o.toDisposable(()=>{n.dispose(),r.makeDirty(!0)})}registerSheetColumnHeaderExtension(e,...t){const r=this._getSheetRenderComponent(e,s.SHEET_VIEW_KEY.COLUMN),n=r.register(...t);return o.toDisposable(()=>{n.dispose(),r.makeDirty(!0)})}registerSheetMainExtension(e,...t){const r=this._getSheetRenderComponent(e,s.SHEET_VIEW_KEY.MAIN),n=r.register(...t);return o.toDisposable(()=>{n.dispose(),r.makeDirty(!0)})}_getSheetRenderComponent(e,t){const n=this._injector.get(d.IRenderManagerService).getRenderById(e);if(!n)throw new Error(`Render Unit with unitId ${e} not found`);const{components:i}=n,a=i.get(t);if(!a)throw new Error("Render component not found");return a}getSheetHooks(){return this._injector.createInstance(u.FSheetHooks)}}o.FUniver.extend(P);const S={CellClicked:"CellClicked",CellPointerDown:"CellPointerDown",CellPointerUp:"CellPointerUp",CellPointerMove:"CellPointerMove",CellHover:"CellHover",DragOver:"DragOver",Drop:"Drop"};class M extends o.FEventName{get BeforeClipboardChange(){return"BeforeClipboardChange"}get ClipboardChanged(){return"ClipboardChanged"}get BeforeClipboardPaste(){return"BeforeClipboardPaste"}get ClipboardPasted(){return"ClipboardPasted"}get BeforeSheetEditStart(){return"BeforeSheetEditStart"}get SheetEditStarted(){return"SheetEditStarted"}get SheetEditChanging(){return"SheetEditChanging"}get BeforeSheetEditEnd(){return"BeforeSheetEditEnd"}get SheetEditEnded(){return"SheetEditEnded"}get CellClicked(){return S.CellClicked}get CellHover(){return S.CellHover}get CellPointerDown(){return S.CellPointerDown}get CellPointerUp(){return S.CellPointerUp}get CellPointerMove(){return S.CellPointerMove}get DragOver(){return"DragOver"}get Drop(){return"Drop"}}o.FEventName.extend(M);class y extends u.FWorkbook{openSiderbar(e){return this._logDeprecation("openSiderbar"),this._injector.get(c.ISidebarService).open(e)}openDialog(e){this._logDeprecation("openDialog");const r=this._injector.get(c.IDialogService).open({...e,onClose:()=>{r.dispose()}});return r}_logDeprecation(e){this._injector.get(o.ILogService).warn("[FWorkbook]",`${e} is deprecated. Please use the function of the same name on "FUniver".`)}addUIEvent(e,t){const r=this.getActiveSheet(),n={workbook:this,worksheet:r};switch(e){case S.CellClicked:this.onCellClick(i=>{this.fireEvent(this.Event.CellClicked,{row:i.location.row,column:i.location.col,...n})});break;case S.CellPointerDown:this.onCellPointerDown(i=>{this.fireEvent(this.Event.CellPointerDown,this.generateCellParams(i))});break;case S.CellPointerUp:this.onCellPointerUp(i=>{this.fireEvent(this.Event.CellPointerUp,this.generateCellParams(i))});break;case S.CellPointerMove:this.onCellPointerMove(i=>{this.fireEvent(this.Event.CellPointerMove,this.generateCellParams(i))});break;case S.CellHover:this.onCellHover(i=>{this.fireEvent(this.Event.CellHover,this.generateCellParams(i))});break;case S.DragOver:this.onDragOver(i=>{this.fireEvent(this.Event.DragOver,{row:i.location.row,column:i.location.col,...n})});break;case S.Drop:this.onDrop(i=>{this.fireEvent(this.Event.Drop,{row:i.location.row,column:i.location.col,...n})})}return o.toDisposable(()=>{})}generateCellParams(e){const t=this.getActiveSheet();return{row:e.row,column:e.col,workbook:this,worksheet:t}}onCellClick(e){const t=this._injector.get(s.HoverManagerService);return o.toDisposable(t.currentClickedCell$.pipe(f.filter(r=>!!r)).subscribe(r=>{e(r)}))}onCellHover(e){const t=this._injector.get(s.HoverManagerService);return o.toDisposable(t.currentRichText$.pipe(f.filter(r=>!!r)).subscribe(e))}onCellPointerDown(e){const t=this._injector.get(s.HoverManagerService);return o.toDisposable(t.currentPointerDownCell$.subscribe(e))}onCellPointerUp(e){const t=this._injector.get(s.HoverManagerService);return o.toDisposable(t.currentPointerUpCell$.subscribe(e))}onCellPointerMove(e){const t=this._injector.get(s.HoverManagerService);return o.toDisposable(t.currentCellPosWithEvent$.pipe(f.filter(r=>!!r)).subscribe(r=>{e(r,r.event)}))}onDragOver(e){const t=this._injector.get(s.DragManagerService);return o.toDisposable(t.currentCell$.pipe(f.filter(r=>!!r)).subscribe(r=>{e(r)}))}onDrop(e){const t=this._injector.get(s.DragManagerService);return o.toDisposable(t.endCell$.pipe(f.filter(r=>!!r)).subscribe(r=>{e(r)}))}startEditing(){return this._injector.get(o.ICommandService).syncExecuteCommand(s.SetCellEditVisibleOperation.id,{eventType:d.DeviceInputEventType.Dblclick,unitId:this._workbook.getUnitId(),visible:!0})}async endEditing(e){return this._injector.get(o.ICommandService).syncExecuteCommand(s.SetCellEditVisibleOperation.id,{eventType:d.DeviceInputEventType.Keyboard,keycode:e?c.KeyCode.ENTER:c.KeyCode.ESC,visible:!1,unitId:this._workbook.getUnitId()}),await o.awaitTime(0),!0}endEditingAsync(e=!0){return this.endEditing(e)}getScrollStateBySheetId(e){const t=this._workbook.getUnitId(),n=this._injector.get(d.IRenderManagerService).getRenderById(t);return n?n.with(s.SheetScrollManagerService).getScrollStateByParam({unitId:t,sheetId:e}):null}disableSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(d.IRenderManagerService).getRenderById(e);return r&&r.with(s.ISheetSelectionRenderService).disableSelection(),this}enableSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(d.IRenderManagerService).getRenderById(e);return r&&r.with(s.ISheetSelectionRenderService).enableSelection(),this}transparentSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(d.IRenderManagerService).getRenderById(e);return r&&r.with(s.ISheetSelectionRenderService).transparentSelection(),this}showSelection(){const e=this._workbook.getUnitId(),r=this._injector.get(d.IRenderManagerService).getRenderById(e);return r&&r.with(s.ISheetSelectionRenderService).showSelection(),this}}u.FWorkbook.extend(y);class D extends u.FWorksheet{refreshCanvas(){const e=this._injector.get(d.IRenderManagerService),t=this._fWorkbook.id,r=e.getRenderById(t);if(!r)throw new Error(`Render Unit with unitId ${t} not found`);r.with(s.SheetSkeletonManagerService).reCalculate();const n=r.mainComponent;if(!n)throw new Error("Main component not found");return n.makeDirty(),this}zoom(e){return this._injector.get(o.ICommandService).syncExecuteCommand(s.ChangeZoomRatioCommand.id,{unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),zoomRatio:e}),this}getZoom(){return this._worksheet.getZoomRatio()}getVisibleRange(){const e=this._workbook.getUnitId(),r=this._injector.get(d.IRenderManagerService).getRenderById(e);let n={startColumn:0,startRow:0,endColumn:0,endRow:0};if(!r)return n;const a=r.with(s.SheetSkeletonManagerService).getCurrentSkeleton();if(!a)return n;const l=a==null?void 0:a.getVisibleRanges();if(!l)return n;n=a.getVisibleRangeByViewport(d.SHEET_VIEWPORT_KEY.VIEW_MAIN);for(const[g,C]of l)d.sheetContentViewportKeys.indexOf(g)!==-1&&(n.startColumn=Math.min(n.startColumn,C.startColumn),n.startRow=Math.min(n.startRow,C.startRow),n.endColumn=Math.max(n.endColumn,C.endColumn),n.endRow=Math.max(n.endRow,C.endRow));return n}scrollToCell(e,t){const r=this._workbook.getUnitId(),i=this._injector.get(d.IRenderManagerService).getRenderById(r);return i&&(i==null?void 0:i.with(s.SheetsScrollRenderController)).scrollToCell(e,t),this}getScrollState(){const e={offsetX:0,offsetY:0,sheetViewStartColumn:0,sheetViewStartRow:0},t=this._workbook.getUnitId(),r=this._worksheet.getSheetId(),i=this._injector.get(d.IRenderManagerService).getRenderById(t);return i&&i.with(s.SheetScrollManagerService).getScrollStateByParam({unitId:t,sheetId:r})||e}onScroll(e){var i;const t=this._workbook.getUnitId(),n=(i=this._injector.get(d.IRenderManagerService).getRenderById(t))==null?void 0:i.with(s.SheetScrollManagerService);if(n){const a=n.validViewportScrollInfo$.subscribe(l=>{e(l)});return o.toDisposable(a)}return o.toDisposable(()=>{})}}u.FWorksheet.extend(D);class R extends u.FPermission{setPermissionDialogVisible(e){this._permissionService.setShowComponents(e)}}u.FPermission.extend(R);class x extends u.FSheetHooks{onCellPointerMove(e){return o.toDisposable(this._injector.get(s.HoverManagerService).currentPosition$.subscribe(e))}onCellPointerOver(e){return o.toDisposable(this._injector.get(s.HoverManagerService).currentCell$.subscribe(e))}onCellDragOver(e){return o.toDisposable(this._injector.get(s.DragManagerService).currentCell$.subscribe(e))}onCellDrop(e){return o.toDisposable(this._injector.get(s.DragManagerService).endCell$.subscribe(e))}onCellRender(e,t=o.InterceptorEffectEnum.Style,r=I.InterceptCellContentPriority.DATA_VALIDATION){return this._injector.get(I.SheetInterceptorService).intercept(I.INTERCEPTOR_POINT.CELL_CONTENT,{effect:t,handler:(n,i,a)=>a({...n,customRender:[...(n==null?void 0:n.customRender)||[],...e||[]]}),priority:r})}onBeforeCellEdit(e){return this._injector.get(o.ICommandService).beforeCommandExecuted(t=>{const r=t.params;t.id===s.SetCellEditVisibleOperation.id&&r.visible&&e(r)})}onAfterCellEdit(e){return this._injector.get(o.ICommandService).onCommandExecuted(t=>{const r=t.params;t.id===s.SetCellEditVisibleOperation.id&&!r.visible&&e(r)})}}u.FSheetHooks.extend(x);class T extends u.FRange{getCell(){const e=this._injector.get(d.IRenderManagerService),t=this._workbook.getUnitId(),r=this._worksheet.getSheetId();return e.getRenderById(t).with(s.SheetSkeletonManagerService).getWorksheetSkeleton(r).skeleton.getCellWithCoordByIndex(this._range.startRow,this._range.startColumn)}getCellRect(){const{startX:e,startY:t,endX:r,endY:n}=this.getCell(),i={x:e,y:t,width:r-e,height:n-t,top:t,left:e,bottom:n,right:r};return{...i,toJSON:()=>JSON.stringify(i)}}generateHTML(){var t;const e=this._injector.get(s.ISheetClipboardService).generateCopyContent(this._workbook.getUnitId(),this._worksheet.getSheetId(),this._range);return(t=e==null?void 0:e.html)!=null?t:""}attachPopup(e){var a,l,g;e.direction=(a=e.direction)!=null?a:"horizontal",e.extraProps=(l=e.extraProps)!=null?l:{},e.offset=(g=e.offset)!=null?g:[0,0];const{key:t,disposableCollection:r}=w(e,this._injector.get(c.ComponentManager)),i=this._injector.get(s.SheetCanvasPopManagerService).attachPopupToCell(this._range.startRow,this._range.startColumn,{...e,componentKey:t},this.getUnitId(),this._worksheet.getSheetId());return i?(r.add(i),r):(r.dispose(),null)}attachAlertPopup(e){const t=this._injector.get(s.CellAlertManagerService),r={workbook:this._workbook,worksheet:this._worksheet,row:this._range.startRow,col:this._range.startColumn,unitId:this.getUnitId(),subUnitId:this._worksheet.getSheetId()};return t.showAlert({...e,location:r}),{dispose:()=>{t.removeAlert(e.key)}}}highlight(e,t){const r=this._injector.get(s.IMarkSelectionService),n=r.addShape({range:this._range,style:e,primary:t});if(!n)throw new Error("Failed to highlight current range");return o.toDisposable(()=>{r.removeShape(n)})}}u.FRange.extend(T);function w(E,e){const{componentKey:t,isVue3:r}=E;let n;const i=new o.DisposableCollection;return typeof t=="string"?n=t:(n=`External_${o.generateRandomId(6)}`,i.add(e.register(n,t,{framework:r?"vue3":"react"}))),{key:n,disposableCollection:i}}h.transformComponentKey=w,Object.defineProperty(h,Symbol.toStringTag,{value:"Module"})});