@univerjs/docs-ui 1.0.0-alpha.0 → 1.0.0-alpha.2

package/lib/types/commands/commands/doc-delete.command.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ICommand, IDocumentBody, Nullable } from '@univerjs/core';
+import type { ICommand, IDocumentBlockRange, IDocumentBody, IMultiCommand, Nullable } from '@univerjs/core';
 import type { IRectRangeWithStyle, ITextRangeWithStyle } from '@univerjs/engine-render';
 import { DeleteDirection } from '@univerjs/core';
 export interface IDeleteCustomBlockParams {
@@ -33,5 +33,9 @@ export declare function getCursorWhenDelete(textRanges: Readonly<Nullable<ITextR
 export declare function isDeleteOffsetInsideBlockRange(body: IDocumentBody, offset: number): boolean;
 export declare const DeleteLeftCommand: ICommand;
 export declare const DeleteRightCommand: ICommand;
-export declare const DeleteCurrentParagraphCommand: ICommand;
+export interface IDeleteCurrentParagraphCommandParams {
+    unitId?: string;
+    blockRange?: IDocumentBlockRange;
+}
+export declare const DeleteCurrentParagraphCommand: IMultiCommand<IDeleteCurrentParagraphCommandParams>;
 export {};

package/lib/types/commands/commands/doc-header-footer.command.d.ts

@@ -14,14 +14,8 @@
  * limitations under the License.
  */
 import type { ICommand } from '@univerjs/core';
-import { BooleanNumber } from '@univerjs/core';
-import { HeaderFooterType } from '../../controllers/doc-header-footer.controller';
-export interface IHeaderFooterProps {
-    marginHeader?: number;
-    marginFooter?: number;
-    useFirstPageHeaderFooter?: BooleanNumber;
-    evenAndOddHeaders?: BooleanNumber;
-}
+import type { IHeaderFooterProps } from '@univerjs/docs';
+import { HeaderFooterType } from '@univerjs/docs';
 export interface ICoreHeaderFooterParams {
     unitId: string;
     createType?: HeaderFooterType;
@@ -37,7 +31,7 @@ interface IOpenHeaderFooterPanelParams {
 }
 export declare const OpenHeaderFooterPanelCommand: ICommand<IOpenHeaderFooterPanelParams>;
 interface ICloseHeaderFooterParams {
-    unitId: string;
+    unitId?: string;
 }
 export declare const CloseHeaderFooterCommand: ICommand<ICloseHeaderFooterParams>;
 export {};

package/lib/types/commands/commands/table/doc-table-create.command.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ICommand, IParagraph, ISectionBreak, ITextRun } from '@univerjs/core';
+import type { ICommand, IDocumentBody, IParagraph, ISectionBreak, ITextRun } from '@univerjs/core';
 export declare const CreateDocTableCommandId = "doc.command.create-table";
 export interface ICreateDocTableCommandParams {
     rowCount: number;
@@ -49,6 +49,7 @@ export declare function shouldCreateParagraphBeforeTable(body: {
 export declare function normalizeTableInsertOffset(body: {
     dataStream: string;
 }, startOffset: number): number;
+export declare function canInsertTableAtOffset(body: Pick<IDocumentBody, 'tables' | 'blockRanges' | 'customBlocks'>, offset: number): boolean;
 /**
  * The command to create a table at cursor point.
  */

package/lib/types/commands/operations/doc-cursor.operation.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { Direction, IOperation } from '@univerjs/core';
-export type DocCursorMoveGranularity = 'character' | 'word' | 'line' | 'document';
+export type DocCursorMoveGranularity = 'character' | 'word' | 'line' | 'paragraph' | 'document';
 export interface IMoveCursorOperationParams {
     direction: Direction;
     granularity?: DocCursorMoveGranularity;

package/lib/types/controllers/doc-header-footer.controller.d.ts

@@ -20,14 +20,6 @@ import { DocSkeletonManagerService } from '@univerjs/docs';
 import { IRenderManagerService } from '@univerjs/engine-render';
 import { IEditorService } from '../services/editor/editor-manager.service';
 import { DocSelectionRenderService } from '../services/selection/doc-selection-render.service';
-export declare enum HeaderFooterType {
-    FIRST_PAGE_HEADER = 0,
-    FIRST_PAGE_FOOTER = 1,
-    DEFAULT_HEADER = 2,
-    DEFAULT_FOOTER = 3,
-    EVEN_PAGE_HEADER = 4,
-    EVEN_PAGE_FOOTER = 5
-}
 export declare class DocHeaderFooterController extends Disposable implements IRenderModule {
     private readonly _context;
     private readonly _commandService;

package/lib/types/controllers/doc-move-cursor.controller.d.ts

@@ -28,18 +28,44 @@ export declare class DocMoveCursorController extends Disposable {
     private _handleShiftMoveSelection;
     private _handleMoveCursor;
     private _getCursorOffsetByGranularity;
+    private _getParagraphBoundaryOffset;
+    private _getCurrentParagraphStartOffset;
     private _getWordBoundaryOffset;
     private _getLineBoundaryOffset;
     private _getFirstCursorGlyphInLine;
     private _getLastCursorGlyphInLine;
     private _isCursorAddressableGlyph;
     private _normalizeCursorOffset;
+    private _normalizeRenderableCursorOffset;
+    private _findNearestRenderableCursorOffset;
+    private _isRenderableCursorOffset;
     private _normalizeWholeEntityRanges;
     private _getCursorSkipTokens;
+    private _getNonRenderableCursorTokens;
     private _getTopOrBottomPosition;
     private _getGlyphLeftOffsetInLine;
     private _matchPositionByLeftOffset;
-    private _getNextOrPrevLine;
+    private _getNextOrPrevLineTarget;
+    private _getTableLineTargetFromPageLine;
+    private _getTableBoundaryLineTarget;
+    private _getAdjacentTableCellLineTarget;
+    private _findAdjacentTableRow;
+    private _findAdjacentTableSliceRow;
+    private _getNearestTableCellLineTarget;
+    private _findLineAroundTable;
+    private _getDistanceToTableCell;
+    private _getTableCellHostOffsetLeft;
+    private _getTableCellContentWidth;
+    private _isTableCellContentPage;
+    private _getColumnGroupLineTargetFromBlockLine;
+    private _getColumnGroupContentLineTarget;
+    private _getColumnGroupExitLineTarget;
+    private _findColumnGroupByBlockLine;
+    private _findColumnGroupBlockLine;
+    private _getAdjacentLineAroundBlockLine;
+    private _getColumnGroupColumnBoundaryLine;
+    private _getDistanceToColumnGroupColumn;
+    private _isColumnGroupContentPage;
     private _scrollToFocusNodePosition;
     private _getDocObject;
 }

package/lib/types/index.d.ts

@@ -31,8 +31,8 @@ export type { IInnerCutCommandParams } from './commands/commands/clipboard.inner
 export { getCustomBlockIdsInSelections, getCutActionsFromDocRanges } from './commands/commands/clipboard.inner.command';
 export { buildMoveDocBlockActions, MoveDocBlockCommand } from './commands/commands/doc-block-move.command';
 export type { IMoveDocBlockCommandParams } from './commands/commands/doc-block-move.command';
-export { DeleteCustomBlockCommand, DeleteLeftCommand, DeleteRightCommand, MergeTwoParagraphCommand, } from './commands/commands/doc-delete.command';
-export type { IDeleteCustomBlockParams } from './commands/commands/doc-delete.command';
+export { DeleteCurrentParagraphCommand, DeleteCustomBlockCommand, DeleteLeftCommand, DeleteRightCommand, MergeTwoParagraphCommand, } from './commands/commands/doc-delete.command';
+export type { IDeleteCurrentParagraphCommandParams, IDeleteCustomBlockParams } from './commands/commands/doc-delete.command';
 export { getCursorWhenDelete } from './commands/commands/doc-delete.command';
 export { HorizontalLineCommand } from './commands/commands/doc-horizontal-line.command';
 export { DocSelectAllCommand } from './commands/commands/doc-select-all.command';
@@ -72,13 +72,15 @@ export { DocBackScrollRenderController } from './controllers/render-controllers/
 export { DocParagraphPlaceholderRenderController, } from './controllers/render-controllers/doc-paragraph-placeholder.render-controller';
 export { DocRenderController } from './controllers/render-controllers/doc.render-controller';
 export { DocUIController } from './controllers/ui.controller';
-export { AlignMenuItemFactory, BackgroundColorSelectorMenuItemFactory, BoldMenuItemFactory, FLOAT_TEXT_STYLE_MENU_ID, FLOAT_TOOLBAR_MENU_POSITION, FloatTextStyleMenuItemFactory, FontFamilySelectorMenuItemFactory, FontSizeSelectorMenuItemFactory, hideMenuWhenSelectionInBlockRange, isTextRangeInAnyBlockRange, ItalicMenuItemFactory, StrikeThroughMenuItemFactory, TextColorSelectorMenuItemFactory, UnderlineMenuItemFactory, } from './menu/menu';
+export { AlignMenuItemFactory, BackgroundColorSelectorMenuItemFactory, BoldMenuItemFactory, disableMenuWhenHeaderFooterEditing, FLOAT_TEXT_STYLE_MENU_ID, FLOAT_TOOLBAR_MENU_POSITION, FloatTextStyleMenuItemFactory, FontFamilySelectorMenuItemFactory, FontSizeSelectorMenuItemFactory, hideMenuWhenSelectionInBlockRange, isTextRangeInAnyBlockRange, ItalicMenuItemFactory, StrikeThroughMenuItemFactory, TextColorSelectorMenuItemFactory, UnderlineMenuItemFactory, } from './menu/menu';
 export { DOC_CONTENT_INSERT_MENU_ID, DOC_PARAGRAPH_T_ALIGN_MENU_ID, DOC_PARAGRAPH_T_COLORS_MENU_ID, DOC_PARAGRAPH_T_DIVIDER_MENU_ID, DOC_PARAGRAPH_T_EDIT_MENU_ID, DOC_PARAGRAPH_T_INSERT_BELOW_MENU_ID, DOC_PARAGRAPH_T_INSERT_MENU_ID, DOC_TABLE_BLOCK_MENU_ID, EMPTY_PARAGRAPH_MENU_ID, getDocBlockRangeMenuId, INSERT_BELLOW_MENU_ID, ParagraphMenuInsertBelowSubmenuItemFactory, } from './menu/paragraph-menu';
 export { menuSchema as DocsUIMenuSchema } from './menu/schema';
 export { UniverDocsUIPlugin } from './plugin';
 export * from './services';
 export { IDocClipboardService } from './services/clipboard/clipboard.service';
 export { convertBodyToHtml } from './services/clipboard/udm-to-html/convertor';
+export { DocHtmlExportService } from './services/clipboard/udm-to-html/doc-html-export.service';
+export type { DocHtmlExportTransformer } from './services/clipboard/udm-to-html/doc-html-export.service';
 export { DocAutoFormatService } from './services/doc-auto-format.service';
 export { DocEventManagerService, getListMarkerFallbackBound, getListParagraphContextMenuHit, } from './services/doc-event-manager.service';
 export type { IBulletBound, IMutiPageParagraphBound } from './services/doc-event-manager.service';

package/lib/types/menu/menu.d.ts

@@ -18,6 +18,7 @@ import type { IMenuButtonItem, IMenuItem, IMenuSelectorItem } from '@univerjs/ui
 import type { LocaleKey } from '../locale/types';
 import { HorizontalAlign, NamedStyleType, PresetListType } from '@univerjs/core';
 import { Observable } from 'rxjs';
+export declare function disableMenuWhenHeaderFooterEditing(accessor: IAccessor): Observable<boolean>;
 export declare function disableMenuWhenNoDocRange(accessor: IAccessor): Observable<boolean>;
 export declare function isTextRangeInAnyBlockRange(document: Nullable<DocumentDataModel>, range: ITextRangeParam): boolean;
 export declare function hideMenuWhenSelectionInBlockRange(accessor: IAccessor): Observable<boolean>;

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

@@ -19,6 +19,7 @@ import { Disposable, ICommandService, ILogService, IUniverInstanceService, Slice
 import { DocSelectionManagerService } from '@univerjs/docs';
 import { ImageSourceType } from '@univerjs/drawing';
 import { IClipboardInterfaceService } from '@univerjs/ui';
+import { DocHtmlExportService } from './udm-to-html/doc-html-export.service';
 export interface IClipboardPropertyItem {
 }
 export interface IDocClipboardHook {
@@ -52,8 +53,8 @@ export declare class DocClipboardService extends Disposable implements IDocClipb
     private readonly _docSelectionManagerService;
     private _clipboardHooks;
     private _htmlToUDM;
-    private _umdToHtml;
-    constructor(_univerInstanceService: IUniverInstanceService, _logService: ILogService, _commandService: ICommandService, _clipboardInterfaceService: IClipboardInterfaceService, _docSelectionManagerService: DocSelectionManagerService);
+    private readonly _umdToHtml;
+    constructor(_univerInstanceService: IUniverInstanceService, _logService: ILogService, _commandService: ICommandService, _clipboardInterfaceService: IClipboardInterfaceService, docHtmlExportService: DocHtmlExportService, _docSelectionManagerService: DocSelectionManagerService);
     copy(sliceType?: SliceBodyType, ranges?: ITextRangeWithStyle[]): Promise<boolean>;
     cut(ranges?: ITextRangeWithStyle[]): Promise<boolean>;
     paste(items: ClipboardItem[]): Promise<boolean>;

package/lib/types/services/clipboard/udm-to-html/convertor.d.ts

@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 import type { IDocumentData, ITextRun } from '@univerjs/core';
+import type { DocHtmlExportService } from './doc-html-export.service';
 export declare function covertTextRunToHtml(dataStream: string, textRun: ITextRun): string;
 export declare function getBodySliceHtml(doc: IDocumentData, startIndex: number, endIndex: number): string;
 export declare function convertBodyToHtml(doc: IDocumentData): string;
 export declare class UDMToHtmlService {
+    private readonly _docHtmlExportService?;
+    constructor(_docHtmlExportService?: Pick<DocHtmlExportService, "transformDocumentForHtmlExport"> | undefined);
     convert(docList: IDocumentData[]): string;
 }

package/lib/types/services/clipboard/udm-to-html/doc-html-export.service.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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, IDocumentData } from '@univerjs/core';
+import { Disposable } from '@univerjs/core';
+export type DocHtmlExportTransformer = (documentData: IDocumentData) => IDocumentData;
+export declare class DocHtmlExportService extends Disposable {
+    private readonly _transformers;
+    registerTransformer(transformer: DocHtmlExportTransformer): IDisposable;
+    transformDocumentForHtmlExport(documentData: IDocumentData): IDocumentData;
+}

package/lib/types/services/doc-paragraph-menu.service.d.ts

@@ -16,15 +16,14 @@
 import type { DocumentDataModel, ICustomBlock, ICustomTable, IDocumentBlockRange } from '@univerjs/core';
 import type { IBoundRectNoAngle, IRenderContext, IRenderModule } from '@univerjs/engine-render';
 import type { IMutiPageParagraphBound, ITableBound } from './doc-event-manager.service';
-import { Disposable } from '@univerjs/core';
+import { Disposable, DocumentBlockType } from '@univerjs/core';
 import { DocSelectionManagerService, DocSkeletonManagerService } from '@univerjs/docs';
 import { DocEventManagerService } from './doc-event-manager.service';
 import { DocCanvasPopManagerService } from './doc-popup-manager.service';
 import { DocFloatMenuService } from './float-menu.service';
 import { DocSelectionRenderService } from './selection/doc-selection-render.service';
-export type DocBlockMenuTargetKind = 'paragraph' | 'blockRange' | 'table' | 'customBlock';
 export interface IDocBlockMenuTarget {
-    kind: DocBlockMenuTargetKind;
+    kind: Exclude<DocumentBlockType, DocumentBlockType.COLUMN_GROUP>;
     key: string;
     paragraph?: IMutiPageParagraphBound;
     blockRange?: IDocumentBlockRange;
@@ -69,7 +68,7 @@ export declare class DocParagraphMenuService extends Disposable implements IRend
     private _docSkeletonManagerService;
     private _floatMenuService;
     private _docSelectionRenderService;
-    private _paragrahMenu;
+    private _paragraphMenu;
     private readonly _activeTarget$;
     readonly activeTarget$: import("rxjs").Observable<IDocBlockMenuTarget | null>;
     private readonly _slashMenuRequest$;

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

@@ -17,5 +17,6 @@ export { default as PastePluginLark } from './clipboard/html-to-udm/paste-plugin
 export { default as PastePluginUniver } from './clipboard/html-to-udm/paste-plugins/plugin-univer';
 export { default as PastePluginWord } from './clipboard/html-to-udm/paste-plugins/plugin-word';
 export { type IPastePlugin } from './clipboard/html-to-udm/paste-plugins/type';
+export type { IDocBlockMenuTarget } from './doc-paragraph-menu.service';
 export { calcDocFitToWidthScale, DocViewScaleService, normalizeDocFitToWidthOptions, resolveDocFitBaseWidth, resolveDocViewScale } from './doc-view-scale';
 export type { ICalcDocFitToWidthScaleParams, IResolveDocFitBaseWidthParams } from './doc-view-scale';

package/lib/types/shortcuts/core-editing.shortcut.d.ts

@@ -18,3 +18,4 @@ export declare const BreakLineShortcut: IShortcutItem;
 export declare const SoftBreakLineShortcut: IShortcutItem;
 export declare const DeleteLeftShortcut: IShortcutItem;
 export declare const DeleteRightShortcut: IShortcutItem;
+export declare const CloseHeaderFooterShortcut: IShortcutItem;

package/lib/types/shortcuts/cursor.shortcut.d.ts

@@ -34,4 +34,8 @@ export declare const MoveCursorWordLeftShortcut: IShortcutItem<object>;
 export declare const MoveCursorWordRightShortcut: IShortcutItem<object>;
 export declare const MoveSelectionWordLeftShortcut: IShortcutItem<object>;
 export declare const MoveSelectionWordRightShortcut: IShortcutItem<object>;
+export declare const MoveCursorParagraphUpShortcut: IShortcutItem<object>;
+export declare const MoveCursorParagraphDownShortcut: IShortcutItem<object>;
+export declare const MoveSelectionParagraphUpShortcut: IShortcutItem<object>;
+export declare const MoveSelectionParagraphDownShortcut: IShortcutItem<object>;
 export declare const SelectAllShortcut: IShortcutItem;

package/lib/types/views/ParagraphMenu.d.ts

@@ -13,17 +13,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { IDocumentBlockRange, IDocumentBody } from '@univerjs/core';
+import type { IDocBlockMoveValidationContext } from '@univerjs/docs';
 import type { ITextRangeWithStyle } from '@univerjs/engine-render';
 import type { IPopup, IValueOption } from '@univerjs/ui';
 import type { CSSProperties } from 'react';
 import type { IMutiPageParagraphBound } from '../services/doc-event-manager.service';
 import type { IDocBlockMenuTarget } from '../services/doc-paragraph-menu.service';
 import { NamedStyleType } from '@univerjs/core';
+import { DocBlockMoveValidatorService } from '@univerjs/docs';
 import { ILayoutService } from '@univerjs/ui';
 import { DocParagraphMenuService } from '../services/doc-paragraph-menu.service';
 export { DOC_PARAGRAPH_MENU_COMPONENT_KEY, DOC_TABLE_BLOCK_MENU_COMPONENT_KEY } from './paragraph-menu/component-keys';
 export declare function getParagraphMenuPopupDirection(anchorLeft: number, menuWidth?: number, viewportPadding?: number): 'left' | 'right';
 export declare const PARAGRAPH_MENU_HOVER_OPEN_DELAY = 800;
+export declare function shouldExecuteParagraphMenuMove(validatorService: Pick<DocBlockMoveValidatorService, 'canMoveBlock'>, context: IDocBlockMoveValidationContext): boolean;
 export declare function createParagraphMenuHoverOpenScheduler(openMenu: () => void, delay?: number): {
     schedule(): void;
     cancel: () => void;
@@ -48,8 +52,17 @@ export declare function getParagraphMenuResolvedCommand(option: IValueOption, ta
     commandId?: string;
     params?: object;
 };
+export declare function getParagraphMenuCommandParams(commandId: string | undefined, commandParams: Record<string, unknown> | undefined, target: IDocBlockMenuTarget | null | undefined, unitId: string): Record<string, unknown> | undefined;
 export declare function shouldShowParagraphSettingMenu(target: IDocBlockMenuTarget | null | undefined): boolean;
 export declare function getParagraphMenuHiddenItemIds(menuType: string, target: IDocBlockMenuTarget | null | undefined, namedStyleType?: NamedStyleType): string[];
+export declare function unwrapBlockRangeBody(documentBody: IDocumentBody, blockRange: IDocumentBlockRange): {
+    body: IDocumentBody;
+    range: {
+        startOffset: number;
+        endOffset: number;
+        collapsed: boolean;
+    };
+};
 export declare function getParagraphFormattingRange(target: IDocBlockMenuTarget | null | undefined, paragraph?: IMutiPageParagraphBound | null): ITextRangeWithStyle | null;
 export declare function getParagraphMenuCommandTargetRange(commandId: string | undefined, targetRange?: ITextRangeWithStyle | null, formattingRange?: ITextRangeWithStyle | null): ITextRangeWithStyle | null | undefined;
 export declare function finishParagraphMenuCommand(docParagraphMenuService: Pick<DocParagraphMenuService, 'hideParagraphMenu'> | null | undefined, layoutService: Pick<ILayoutService, 'focus'>, hideMenu: () => void): void;

package/lib/types/views/paragraph-setting/line-spacing.d.ts

@@ -14,24 +14,12 @@
  * limitations under the License.
  */
 import type { LocaleService } from '@univerjs/core';
+import type { IDocumentSkeletonLine } from '@univerjs/engine-render';
 import { SpacingRule } from '@univerjs/core';
 interface ILineSpacingMetrics {
     glyphLineHeight: number;
     renderedLineHeight: number;
 }
-interface ILineSpacingLike {
-    contentHeight?: number;
-    paddingTop?: number;
-    paddingBottom?: number;
-    divides?: Array<{
-        glyphGroup?: Array<{
-            bBox?: {
-                ba?: number;
-                bd?: number;
-            };
-        }>;
-    }>;
-}
 export declare function getLineSpacingRuleOptions(localeService: LocaleService): {
     label: string;
     value: string;
@@ -46,6 +34,6 @@ export declare function getLineSpacingInputConfig(spacingRule: SpacingRule): {
 };
 export declare function convertStoredLineSpacingToDisplayValue(lineSpacing: number, spacingRule: SpacingRule): number;
 export declare function convertDisplayLineSpacingToStoredValue(lineSpacing: number, spacingRule: SpacingRule): number;
-export declare function getLineSpacingMetrics(lineNode?: ILineSpacingLike | null): ILineSpacingMetrics | null;
+export declare function getLineSpacingMetrics(lineNode?: IDocumentSkeletonLine): ILineSpacingMetrics | null;
 export declare function convertLineSpacingForRuleChange(currentStoredValue: number, currentRule: SpacingRule, nextRule: SpacingRule, metrics?: ILineSpacingMetrics | null): number;
 export {};