@cool-office/docs-ui 0.0.0-stage → 1.2.0

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

@@ -0,0 +1,77 @@
+/**
+ * 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 { DocumentDataModel, IAccessor, ITextRangeParam, Nullable } from '@cool-office/core';
+import type { IMenuButtonItem, IMenuItem, IMenuSelectorItem } from '@cool-office/ui';
+import type { LocaleKey } from '../locale/types';
+import { HorizontalAlign, NamedStyleType, PresetListType } from '@cool-office/core';
+import { UnitAction } from '@cool-office/protocol';
+import { Observable } from 'rxjs';
+export declare function shouldSuppressDocMenuStateRefresh(accessor: IAccessor): boolean;
+export declare function disableMenuWhenHeaderFooterEditing(accessor: IAccessor): Observable<boolean>;
+export declare function disableMenuWhenNoDocRange(accessor: IAccessor): Observable<boolean>;
+export declare function disableMenuWithoutDocumentUnitPermission(accessor: IAccessor, action: UnitAction): Observable<boolean>;
+export declare const DOC_INSERT_EMOJI_MENU_ID = "doc.menu.insert-emoji";
+export declare const DOC_INSERT_SYMBOL_MENU_ID = "doc.menu.insert-symbol";
+export declare function EmojiPickerMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<string, string, string>;
+export declare function SymbolPickerMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<string, string, string>;
+export declare function isTextRangeInAnyBlockRange(document: Nullable<DocumentDataModel>, range: ITextRangeParam): boolean;
+export declare function hideMenuWhenSelectionInBlockRange(accessor: IAccessor): Observable<boolean>;
+export declare function BoldMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ItalicMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function UnderlineMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function StrikeThroughMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function SubscriptMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function SuperscriptMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function FontFamilySelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, string, string>;
+export declare function FontSizeSelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, number>;
+export declare function HeadingSelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, NamedStyleType>;
+export declare const FLOAT_TEXT_STYLE_MENU_ID = "doc.menu.float-text-style";
+export declare const FLOAT_TOOLBAR_MENU_POSITION = "doc.menu.float-toolbar";
+export declare function FloatTextStyleMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, string | number>;
+export declare function TextColorSelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, string, string | undefined>;
+export declare function HeaderFooterMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare const DOC_BREAKS_MENU_ID = "doc.menu.breaks";
+export declare const DOC_SECTION_BREAK_NEXT_PAGE_MENU_ID = "doc.menu.section-break.next-page";
+export declare const DOC_SECTION_BREAK_CONTINUOUS_MENU_ID = "doc.menu.section-break.continuous";
+export declare const DOC_SECTION_BREAK_NEXT_COLUMN_MENU_ID = "doc.menu.section-break.next-column";
+export declare const DOC_SECTION_BREAK_EVEN_PAGE_MENU_ID = "doc.menu.section-break.even-page";
+export declare const DOC_SECTION_BREAK_ODD_PAGE_MENU_ID = "doc.menu.section-break.odd-page";
+export declare function BreaksMenuFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function InsertColumnBreakMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function InsertNextPageSectionBreakMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function InsertContinuousSectionBreakMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function InsertNextColumnSectionBreakMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function InsertEvenPageSectionBreakMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function InsertOddPageSectionBreakMenuFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare const TableIcon = "GridIcon";
+export declare const TABLE_MENU_ID = "doc.menu.table";
+export declare function TableMenuFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function InsertTableMenuFactory(_accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function InsertDefaultTableMenuFactory(_accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function AlignLeftMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function AlignCenterMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function AlignRightMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function AlignJustifyMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function AlignMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, HorizontalAlign, HorizontalAlign>;
+export declare function HorizontalLineFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function OrderListMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, PresetListType | undefined, PresetListType | undefined>;
+export declare function BulletListMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, PresetListType | undefined, PresetListType | undefined>;
+export declare function CheckListMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ResetTextColorMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ResetBackgroundColorMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function BackgroundColorSelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey, string, string | undefined>;
+export declare function getParagraphStyleAtCursor(accessor: IAccessor): import("@cool-office/core").IParagraph | null | undefined;
+export declare function PageSettingMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;

package/lib/types/menu/mobile-schema.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { MenuSchemaType } from '@cool-office/ui';
+export declare const mobileMenuSchema: MenuSchemaType;

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

@@ -0,0 +1,90 @@
+/**
+ * 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 { IAccessor } from '@cool-office/core';
+import type { IMenuButtonItem, IMenuItem, IMenuSelectorItem } from '@cool-office/ui';
+import type { LocaleKey } from '../locale/types';
+export declare const TEXT_COLORS: string[];
+export declare const TEXT_COLOR_SWATCH_ICONS: readonly ["DocParagraphTextColorSwatchIcon.0", "DocParagraphTextColorSwatchIcon.1", "DocParagraphTextColorSwatchIcon.2", "DocParagraphTextColorSwatchIcon.3", "DocParagraphTextColorSwatchIcon.4", "DocParagraphTextColorSwatchIcon.5", "DocParagraphTextColorSwatchIcon.6"];
+export declare const BACKGROUND_COLOR_SWATCH_ICONS: readonly ["DocParagraphBackgroundColorSwatchIcon.0", "DocParagraphBackgroundColorSwatchIcon.1", "DocParagraphBackgroundColorSwatchIcon.2", "DocParagraphBackgroundColorSwatchIcon.3", "DocParagraphBackgroundColorSwatchIcon.4", "DocParagraphBackgroundColorSwatchIcon.5", "DocParagraphBackgroundColorSwatchIcon.6", "DocParagraphBackgroundColorSwatchIcon.7", "DocParagraphBackgroundColorSwatchIcon.8", "DocParagraphBackgroundColorSwatchIcon.9", "DocParagraphBackgroundColorSwatchIcon.10", "DocParagraphBackgroundColorSwatchIcon.11", "DocParagraphBackgroundColorSwatchIcon.12", "DocParagraphBackgroundColorSwatchIcon.13", "DocParagraphBackgroundColorSwatchIcon.14"];
+export declare function H1HeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function H2HeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function H3HeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function H4HeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function H5HeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function NormalTextHeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function TitleHeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function SubtitleHeadingMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare const EMPTY_PARAGRAPH_MENU_ID = "doc.menu.empty-paragraph";
+export declare function EmptyParagraphH1MenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphH2MenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphH3MenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphH4MenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphH5MenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphNormalTextMenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphOrderListMenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphBulletListMenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphCheckListMenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function EmptyParagraphHorizontalLineMenuItemFactory(): IMenuButtonItem<LocaleKey>;
+export declare function CopyCurrentParagraphMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function CutCurrentParagraphMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function DeleteCurrentParagraphMenuItemFactory(): IMenuItem<LocaleKey>;
+export declare function InsertBulletListBellowMenuItemFactory(): IMenuItem<LocaleKey>;
+export declare function InsertOrderListBellowMenuItemFactory(): IMenuItem<LocaleKey>;
+export declare function InsertCheckListBellowMenuItemFactory(): IMenuItem<LocaleKey>;
+export declare function InsertHorizontalLineBellowMenuItemFactory(): IMenuItem<LocaleKey>;
+export declare const INSERT_BELLOW_MENU_ID = "doc.menu.insert-bellow";
+export declare const DOC_CONTENT_INSERT_MENU_ID = "doc.menu.content-insert";
+export declare const DOC_TABLE_BLOCK_MENU_ID = "doc.menu.table-block";
+export declare const DOC_PARAGRAPH_T_INSERT_MENU_ID = "doc.menu.paragraph-t.insert";
+export declare const DOC_PARAGRAPH_T_EDIT_MENU_ID = "doc.menu.paragraph-t.edit";
+export declare const DOC_PARAGRAPH_T_DIVIDER_MENU_ID = "doc.menu.paragraph-t.divider";
+export declare const DOC_PARAGRAPH_T_ALIGN_MENU_ID = "doc.menu.paragraph-t.align";
+export declare const DOC_PARAGRAPH_T_COLORS_MENU_ID = "doc.menu.paragraph-t.colors";
+export declare const DOC_PARAGRAPH_T_INSERT_BELOW_MENU_ID = "doc.menu.paragraph-t.insert-below";
+export declare const DOC_PARAGRAPH_T_RESET_COLORS_ID = "doc.menu.paragraph-t.reset-colors";
+export declare const DOC_PARAGRAPH_T_INDENT_INCREASE_ID = "doc.menu.paragraph-t.indent.increase";
+export declare const DOC_PARAGRAPH_T_INDENT_DECREASE_ID = "doc.menu.paragraph-t.indent.decrease";
+export declare const DOC_PARAGRAPH_T_INSERT_BELOW_COMMAND_ID = "doc.menu.paragraph-t.insert-below.command";
+export declare function getDocBlockRangeMenuId(blockType: string): string;
+export declare function TableBlockCopyMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function TableBlockPasteMenuItemFactory(): IMenuItem<LocaleKey>;
+export declare function TableBlockDeleteMenuItemFactory(): IMenuItem<LocaleKey>;
+export declare function DocInsertBellowMenuItemFactory(): IMenuSelectorItem<LocaleKey>;
+export declare function ParagraphMenuAlignSubmenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey>;
+export declare function ParagraphMenuColorsSubmenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey>;
+export declare function ParagraphMenuTextColorHeaderActionMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function ParagraphMenuBackgroundColorHeaderActionMenuItemFactory(accessor: IAccessor): IMenuItem<LocaleKey>;
+export declare function ParagraphMenuInsertBelowSubmenuItemFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey>;
+export declare function ParagraphMenuInsertBelowHeadingH1MenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuInsertBelowHeadingH2MenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuInsertBelowHeadingH3MenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuInsertBelowHeadingH4MenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuInsertBelowHeadingH5MenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuInsertBelowTableMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuIndentIncreaseMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuIndentDecreaseMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuDefaultTextColorMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuNoBackgroundMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuResetTextColorMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare function ParagraphMenuResetColorsMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
+export declare const ParagraphMenuTextColorSwatchMenuItemFactories: Record<string, {
+    order: number;
+    menuItemFactory: (accessor: IAccessor) => IMenuButtonItem<LocaleKey>;
+}>;
+export declare const ParagraphMenuBackgroundColorSwatchMenuItemFactories: Record<string, {
+    order: number;
+    menuItemFactory: (accessor: IAccessor) => IMenuButtonItem<LocaleKey>;
+}>;

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

@@ -0,0 +1,19 @@
+/**
+ * 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 { IAccessor } from '@cool-office/core';
+import type { IMenuButtonItem } from '@cool-office/ui';
+export declare function DocPermissionMenuItemFactory(accessor: IAccessor): IMenuButtonItem;
+export declare function DocParagraphPermissionMenuItemFactory(accessor: IAccessor): IMenuButtonItem;

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

@@ -0,0 +1,18 @@
+/**
+ * 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 { MenuSchemaType } from '@cool-office/ui';
+export declare const floatToolbarMenuSchema: MenuSchemaType;
+export declare const menuSchema: MenuSchemaType;

package/lib/types/mobile-plugin.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { IUniverDocsUIConfig } from './config/config';
+import { ICommandService, IConfigService, Injector, Plugin } from '@cool-office/core';
+import { IRenderManagerService } from '@cool-office/engine-render';
+export declare class UniverDocsMobileUIPlugin extends Plugin {
+    private readonly _config;
+    _injector: Injector;
+    private readonly _renderManagerSrv;
+    private _commandService;
+    private readonly _configService;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    constructor(_config: Partial<IUniverDocsUIConfig> | undefined, _injector: Injector, _renderManagerSrv: IRenderManagerService, _commandService: ICommandService, _configService: IConfigService);
+    onReady(): void;
+    onRendered(): void;
+    private _initCommand;
+    private _initDependencies;
+    private _initAutoFocus;
+    private _initRenderBasics;
+    private _initRenderModules;
+}

package/lib/types/plugin.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { ICommandService, IConfigService, Injector, Plugin } from '@cool-office/core';
+import { IRenderManagerService } from '@cool-office/engine-render';
+import type { IUniverDocsUIConfig } from './config/config';
+export declare class UniverDocsUIPlugin extends Plugin {
+    private readonly _config;
+    _injector: Injector;
+    private readonly _renderManagerSrv;
+    private _commandService;
+    private readonly _configService;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    constructor(_config: Partial<IUniverDocsUIConfig> | undefined, _injector: Injector, _renderManagerSrv: IRenderManagerService, _commandService: ICommandService, _configService: IConfigService);
+    onReady(): void;
+    onRendered(): void;
+    private _initCommand;
+    private _initializeShortcut;
+    private _initDependencies;
+    private _initAutoFocus;
+    private _initRenderBasics;
+    private _initRenderModules;
+}

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

@@ -0,0 +1,136 @@
+/**
+ * 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, IDocumentBody, IDocumentData } from '@cool-office/core';
+import type { IRectRangeWithStyle, ITextRangeWithStyle } from '@cool-office/engine-render';
+import type { Observable } from 'rxjs';
+import { Disposable, ErrorService, ICommandService, ILogService, ImageSourceType, IPermissionService, IUndoRedoService, IUniverInstanceService, SliceBodyType } from '@cool-office/core';
+import { DocSelectionManagerService, DocStateChangeManagerService } from '@cool-office/docs';
+import { IClipboardInterfaceService } from '@cool-office/ui';
+import type { DocPasteMode } from './paste-options';
+import { DocMenuStyleService } from '../doc-menu-style.service';
+import { DocHtmlExportService } from './udm-to-html/doc-html-export.service';
+export declare function convertClipboardHtmlToDocumentData(html: string, unitId?: string): Partial<IDocumentData>;
+export declare function removeClipboardHtmlImages(html: string): string;
+export interface IClipboardPropertyItem {
+}
+export interface IDocClipboardCopyDocDataContext {
+    sourceDocuments: IDocumentData[];
+}
+export interface IDocClipboardCopyContentContext {
+    body: IDocumentBody;
+    segmentId?: string;
+    unitId: string;
+}
+export interface IDocClipboardPasteContext {
+    documentData: Partial<IDocumentData>;
+    targetUnitId: string;
+}
+export interface IDocClipboardHook {
+    /** Opt an internal rich-text editor into the post-paste format menu. */
+    supportsPasteOptions?(unitId: string): boolean;
+    /** Supply a rich fragment for selections owned by a plugin rather than native text ranges. */
+    onCopySelection?(unitId: string): {
+        documentData: IDocumentData;
+        plainText: string;
+    } | undefined;
+    onCopyDocData?(doc: Partial<IDocumentData>, context: IDocClipboardCopyDocDataContext): Partial<IDocumentData>;
+    onCopyProperty?(start: number, end: number): IClipboardPropertyItem;
+    onCopyContent?(start: number, end: number, context: IDocClipboardCopyContentContext): string;
+    onBeforePaste?: (body: IDocumentBody, context: IDocClipboardPasteContext) => IDocumentBody;
+    onBeforePasteImage?: (file: File) => Promise<{
+        source: string;
+        imageSourceType: ImageSourceType;
+    } | null>;
+}
+export interface IDocClipboardPayload {
+    html?: string;
+    text?: string;
+    internalJson?: string;
+    files: File[];
+    unitId?: string;
+    mode?: DocPasteMode;
+}
+export interface IDocPasteOptionsState {
+    unitId: string;
+    mode: DocPasteMode;
+    range: ITextRangeWithStyle;
+}
+export interface IDocClipboardService {
+    copy(sliceType?: SliceBodyType, ranges?: ITextRangeWithStyle[]): Promise<boolean>;
+    cut(ranges?: ITextRangeWithStyle[]): Promise<boolean>;
+    paste(items?: ClipboardItem[], mode?: DocPasteMode): Promise<boolean>;
+    pasteFromClipboard(mode?: DocPasteMode): Promise<boolean>;
+    legacyPaste(options: IDocClipboardPayload): Promise<boolean>;
+    readonly pasteOptions$: Observable<IDocPasteOptionsState | null>;
+    isPasteOptionsEnabled(unitId: string): boolean;
+    setNextPasteMode(mode: DocPasteMode): void;
+    dismissPasteOptions(): void;
+    changePasteMode(mode: DocPasteMode): Promise<boolean>;
+    addClipboardHook(hook: IDocClipboardHook): IDisposable;
+}
+export declare function getTableClipboardBodySlice(body: IDocumentBody, range: IRectRangeWithStyle): IDocumentBody;
+export declare const IDocClipboardService: import("@wendellhu/redi").IdentifierDecorator<IDocClipboardService>;
+export declare class DocClipboardService extends Disposable implements IDocClipboardService {
+    private readonly _univerInstanceService;
+    private readonly _logService;
+    private readonly _commandService;
+    private readonly _permissionService;
+    private readonly _clipboardInterfaceService;
+    private readonly _errorService;
+    private readonly _docSelectionManagerService;
+    private readonly _stateChangeManager;
+    private readonly _menuStyleService;
+    private readonly _undoRedoService;
+    private readonly _pasteOptions$;
+    readonly pasteOptions$: Observable<IDocPasteOptionsState | null>;
+    private _pasteSession;
+    private _applyingPaste;
+    private _pasteGeneration;
+    private _nextPasteMode;
+    private _lastSelectionKey;
+    private _clipboardHooks;
+    private _memoryClipboardData;
+    private _htmlToUDM;
+    private readonly _umdToHtml;
+    constructor(_univerInstanceService: IUniverInstanceService, _logService: ILogService, _commandService: ICommandService, _permissionService: IPermissionService, _clipboardInterfaceService: IClipboardInterfaceService, _errorService: ErrorService, docHtmlExportService: DocHtmlExportService, _docSelectionManagerService: DocSelectionManagerService, _stateChangeManager: DocStateChangeManagerService, _menuStyleService: DocMenuStyleService, _undoRedoService: IUndoRedoService);
+    copy(sliceType?: SliceBodyType, ranges?: ITextRangeWithStyle[]): Promise<boolean>;
+    cut(ranges?: ITextRangeWithStyle[]): Promise<boolean>;
+    pasteFromClipboard(mode?: DocPasteMode): Promise<boolean>;
+    paste(items?: ClipboardItem[], mode?: DocPasteMode): Promise<boolean>;
+    isPasteOptionsEnabled(unitId: string): boolean;
+    setNextPasteMode(mode: DocPasteMode): void;
+    legacyPaste(options: IDocClipboardPayload): Promise<boolean>;
+    dismissPasteOptions(): void;
+    changePasteMode(mode: DocPasteMode): Promise<boolean>;
+    private _preparePaste;
+    private _pasteWithOptions;
+    private _getPasteStyle;
+    private _getPasteSelectionKey;
+    private _savePasteSession;
+    private _getCurrentDocumentUnitId;
+    private _canEditTargets;
+    private _cut;
+    private _paste;
+    private _setClipboardData;
+    private _getSelectionParams;
+    addClipboardHook(hook: IDocClipboardHook): IDisposable;
+    private _applyCopyDocDataHooks;
+    private _getDocumentBodyInRanges;
+    private _readClipboardItems;
+    private _genDocDataFromHtmlAndText;
+    private _uploadBase64ImagesInHtml;
+    private _createImagePasteHtml;
+}

package/lib/types/services/clipboard/copy-content-cache.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { IDocumentData } from '@cool-office/core';
+export declare function extractId(html: string): string | null;
+export declare class CopyContentCache {
+    private _cache;
+    set(id: string, clipboardData: Partial<IDocumentData>): void;
+    get(id: string): Partial<IDocumentData> | undefined;
+    clear(): void;
+}
+export declare const copyContentCache: CopyContentCache;

package/lib/types/services/clipboard/doc-paste-mutation-adapter.service.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { ICustomRange, IDisposable, IDocumentBlockRange, IDocumentBody, IDocumentData, IDrawingParam, IMutationInfo } from '@cool-office/core';
+export interface IDocClipboardPasteCustomBlockMapping {
+    sourceBlockId: string;
+    targetBlockId: string;
+    sourceDrawing: IDrawingParam;
+    targetDrawing: IDrawingParam;
+}
+export interface IDocClipboardPasteBlockRangeMapping {
+    sourceBlockRange: IDocumentBlockRange;
+    targetBlockRange: IDocumentBlockRange;
+}
+export interface IDocClipboardPasteCustomRangeMapping {
+    sourceRange: ICustomRange;
+    targetRange: ICustomRange;
+}
+export interface IDocClipboardPasteMutationInfoParams {
+    unitId: string;
+    segmentId: string;
+    doc: Partial<IDocumentData>;
+    sourceBody: IDocumentBody;
+    targetBody: IDocumentBody;
+    blockRangeMappings: IDocClipboardPasteBlockRangeMapping[];
+    customRangeMappings?: IDocClipboardPasteCustomRangeMapping[];
+    customBlockMappings: IDocClipboardPasteCustomBlockMapping[];
+}
+export interface IDocClipboardPasteMutationInfos {
+    redoMutations: IMutationInfo[];
+    undoMutations: IMutationInfo[];
+}
+export interface IDocClipboardPasteAdapter {
+    getPasteMutationInfos?: (params: IDocClipboardPasteMutationInfoParams) => IDocClipboardPasteMutationInfos | null | undefined;
+}
+export interface IDocClipboardPasteAdapterService {
+    registerAdapter(adapter: IDocClipboardPasteAdapter): IDisposable;
+    getPasteMutationInfos(params: IDocClipboardPasteMutationInfoParams): IDocClipboardPasteMutationInfos;
+}
+export declare const IDocClipboardPasteAdapterService: import("@wendellhu/redi").IdentifierDecorator<IDocClipboardPasteAdapterService>;
+export declare class DocClipboardPasteAdapterService implements IDocClipboardPasteAdapterService {
+    private readonly _adapters;
+    registerAdapter(adapter: IDocClipboardPasteAdapter): IDisposable;
+    getPasteMutationInfos(params: IDocClipboardPasteMutationInfoParams): IDocClipboardPasteMutationInfos;
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { IDocumentData } from '@cool-office/core';
+import type { IPastePlugin } from './paste-plugins/type';
+/**
+ * Convert html strings into data structures in univer, IDocumentBody.
+ * Support plug-in, add custom rules,
+ */
+export declare class HtmlToUDMService {
+    private static _pluginList;
+    static use(plugin: IPastePlugin): void;
+    private _tableCache;
+    private _styleCache;
+    private _styleRules;
+    private _afterProcessRules;
+    private _listStack;
+    private _lastParagraphIndex;
+    private _createParagraphId;
+    private _createSectionId;
+    convert(html: string, metaConfig?: {
+        unitId?: string;
+    }): Partial<IDocumentData>;
+    private _process;
+    private _processCodeBlock;
+    private _processBeforeStructuredBlock;
+    private _processAfterStructuredBlock;
+    private _processBeforeList;
+    private _processAfterList;
+    private _processAfterDefaultBlock;
+    private _appendParagraph;
+    private _applyListInfo;
+    private _processHtmlTable;
+    private _appendHtmlTableCell;
+    private _processBeforeTable;
+    private _processAfterTable;
+    private _processBeforeLink;
+    private _processAfterLink;
+}

package/lib/types/services/clipboard/html-to-udm/parse-node-style.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { ITextStyle } from '@cool-office/core';
+export declare function extractNodeStyle(node: HTMLElement): ITextStyle;

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

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export default function parseToDom(rawHtml: string): Element | null;

package/lib/types/services/clipboard/html-to-udm/paste-plugins/plugin-lark.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { IPastePlugin } from './type';
+declare const LarkPastePlugin: IPastePlugin;
+export default LarkPastePlugin;

package/lib/types/services/clipboard/html-to-udm/paste-plugins/plugin-univer.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { IPastePlugin } from './type';
+declare const UniverPastePlugin: IPastePlugin;
+export default UniverPastePlugin;