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

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

@@ -0,0 +1,44 @@
+/**
+ * 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 { ICommand, IDocumentBlockRange, IDocumentBody, IMultiCommand, Nullable } from '@cool-office/core';
+import type { IRectRangeWithStyle, ITextRangeWithStyle } from '@cool-office/engine-render';
+import { DeleteDirection } from '@cool-office/core';
+export interface IDeleteCustomBlockParams {
+    direction: DeleteDirection;
+    range: ITextRangeWithStyle;
+    unitId: string;
+    drawingId: string;
+}
+export declare const DeleteCustomBlockCommand: ICommand<IDeleteCustomBlockParams>;
+interface IMergeTwoParagraphParams {
+    direction: DeleteDirection;
+    range: ITextRangeWithStyle;
+}
+export declare const MergeTwoParagraphCommand: ICommand<IMergeTwoParagraphParams>;
+export declare const RemoveHorizontalLineCommand: ICommand;
+export declare function getCursorWhenDelete(textRanges: Readonly<Nullable<ITextRangeWithStyle[]>>, rectRanges: readonly IRectRangeWithStyle[]): number;
+export declare function isDeleteOffsetInsideBlockRange(body: IDocumentBody, offset: number): boolean;
+export interface IDeleteBoundaryParams {
+    granularity?: 'word' | 'line';
+}
+export declare const DeleteLeftCommand: ICommand<IDeleteBoundaryParams>;
+export declare const DeleteRightCommand: ICommand<IDeleteBoundaryParams>;
+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

@@ -0,0 +1,40 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+import type { IHeaderFooterProps } from '@cool-office/docs';
+import { HeaderFooterType } from '@cool-office/docs';
+import { DocumentEditArea } from '@cool-office/engine-render';
+export interface ICoreHeaderFooterParams {
+    unitId: string;
+    createType?: HeaderFooterType;
+    segmentId?: string;
+    sectionId?: string;
+    headerFooterProps?: IHeaderFooterProps;
+}
+export declare const CoreHeaderFooterCommandId = "doc.command.core-header-footer";
+/**
+ * The command to update header and footer or create them.
+ */
+export declare const CoreHeaderFooterCommand: ICommand<ICoreHeaderFooterParams>;
+interface IOpenHeaderFooterPanelParams {
+    editArea?: DocumentEditArea.HEADER | DocumentEditArea.FOOTER;
+}
+export declare const OpenHeaderFooterPanelCommand: ICommand<IOpenHeaderFooterPanelParams>;
+interface ICloseHeaderFooterParams {
+    unitId?: string;
+}
+export declare const CloseHeaderFooterCommand: ICommand<ICloseHeaderFooterParams>;
+export {};

package/lib/types/commands/commands/doc-horizontal-line.command.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 { ICommand, ITextRangeParam } from '@cool-office/core';
+import { BreakLineInsertionMode } from './break-line.command';
+interface IHorizontalCommandParams {
+    insertionMode?: BreakLineInsertionMode;
+    insertRange?: ITextRangeParam;
+}
+export declare const HorizontalLineCommand: ICommand<IHorizontalCommandParams>;
+export declare const InsertHorizontalLineBellowCommand: ICommand<IHorizontalCommandParams>;
+export {};

package/lib/types/commands/commands/doc-page-setup.command.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { ICommand, ISize, PageOrientType } from '@cool-office/core';
+import { DocumentFlavor } from '@cool-office/core';
+export interface IDocPageSetupCommandParams {
+    pageSize: ISize;
+    pageOrient: PageOrientType;
+    documentFlavor?: DocumentFlavor;
+    marginTop: number;
+    marginBottom: number;
+    marginLeft: number;
+    marginRight: number;
+}
+export declare const DocPageSetupCommand: ICommand<IDocPageSetupCommandParams>;

package/lib/types/commands/commands/doc-paragraph-setting.command.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 { ICommand, IParagraphStyle } from '@cool-office/core';
+export interface IDocParagraphSettingCommandParams {
+    paragraph?: Partial<Pick<IParagraphStyle, 'hanging' | 'horizontalAlign' | 'spaceBelow' | 'spaceAbove' | 'indentEnd' | 'indentStart' | 'lineSpacing' | 'indentFirstLine' | 'snapToGrid' | 'spacingRule'>>;
+}
+export declare const DocParagraphSettingCommand: ICommand<IDocParagraphSettingCommandParams>;

package/lib/types/commands/commands/doc-select-all.command.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 { ICommand } from '@cool-office/core';
+interface ISelectAllCommandParams {
+    segmentId?: string;
+    wholeDocument?: boolean;
+}
+export declare const DocSelectAllCommand: ICommand<ISelectAllCommandParams>;
+export declare const DocSelectWordCommand: ICommand;
+export {};

package/lib/types/commands/commands/format-painter.command.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { IBullet, ICommand, IDocumentBody, IDocumentData, IListData, IParagraphStyle, ITextRangeParam, ITextStyle } from '@cool-office/core';
+import { TextX } from '@cool-office/core';
+export interface ITextFormatPainterSnapshot {
+    textStyle: ITextStyle;
+    paragraphStyle?: IParagraphStyle;
+    bullet?: IBullet;
+    listDefinition?: IListData;
+}
+export declare function captureTextFormat(body: IDocumentBody, range: Pick<ITextRangeParam, 'startOffset' | 'endOffset'>, defaultStyle?: ITextStyle, lists?: Record<string, IListData>, document?: Pick<IDocumentData, 'documentStyle' | 'styles'>): ITextFormatPainterSnapshot;
+/** Replace formatting only, preserving text, entity markers and paragraph identities. */
+export declare function buildTextFormatActions(body: IDocumentBody, ranges: ITextRangeParam[], format: ITextFormatPainterSnapshot): TextX;
+interface IApplyTextFormatPainterCommandParams {
+    unitId: string;
+    ranges: ITextRangeParam[];
+    format: ITextFormatPainterSnapshot;
+}
+export declare const ApplyTextFormatPainterCommand: ICommand<IApplyTextFormatPainterCommandParams>;
+export {};

package/lib/types/commands/commands/ime-input.command.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+export interface IIMEInputCommandParams {
+    unitId: string;
+    newText: string;
+    oldTextLen: number;
+    isCompositionStart: boolean;
+    isCompositionEnd: boolean;
+    isCompositionCanceled?: boolean;
+}
+export declare const IMEInputCommand: ICommand<IIMEInputCommandParams>;

package/lib/types/commands/commands/inline-format.command.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 { ICommand, IDocumentBody, ITextStyle } from '@cool-office/core';
+import type { ITextRangeWithStyle } from '@cool-office/engine-render';
+export interface ISetInlineFormatCommandParams {
+    preCommandId: string;
+    value?: string | Partial<ITextStyle> | null;
+}
+export declare const SetInlineFormatBoldCommand: ICommand;
+export declare const SetInlineFormatItalicCommand: ICommand;
+export declare const SetInlineFormatUnderlineCommand: ICommand;
+export declare const SetInlineFormatStrikethroughCommand: ICommand;
+export declare const SetInlineFormatSubscriptCommand: ICommand;
+export declare const SetInlineFormatSuperscriptCommand: ICommand;
+export declare const SetInlineFormatFontSizeCommand: ICommand;
+export declare const SetInlineFormatFontFamilyCommand: ICommand;
+export declare const SetInlineFormatTextColorCommand: ICommand;
+export declare const ResetInlineFormatTextColorCommand: ICommand;
+export declare const SetInlineFormatTextFillCommand: ICommand;
+export declare const SetInlineFormatTextBackgroundColorCommand: ICommand;
+export declare const ResetInlineFormatTextBackgroundColorCommand: ICommand;
+export declare const SetInlineFormatCommand: ICommand<ISetInlineFormatCommandParams>;
+export declare function getStyleInTextRange(body: IDocumentBody, textRange: ITextRangeWithStyle, defaultStyle: ITextStyle): ITextStyle;

package/lib/types/commands/commands/insert-below/insert-bullet-below.command.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { ICommand, PresetListType } from '@cool-office/core';
+interface IInsertBulletBelowCommandParams {
+    listType: PresetListType;
+}
+export declare const InsertBulletBelowCommand: ICommand<IInsertBulletBelowCommandParams>;
+export {};

package/lib/types/commands/commands/insert-custom-range.command.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+import type { ITextRangeWithStyle } from '@cool-office/engine-render';
+export interface IInsertCustomRangeCommandParams {
+    unitId: string;
+    rangeId?: string;
+    textRanges?: ITextRangeWithStyle[];
+    properties?: Record<string, any>;
+    text: string;
+    wholeEntity?: boolean;
+}
+export declare const InsertCustomRangeCommand: ICommand<IInsertCustomRangeCommandParams>;

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

@@ -0,0 +1,28 @@
+/**
+ * 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 { ICommand, ITextRange } from '@cool-office/core';
+import type { DateTimeFieldFormat } from '../../utils/date-time-field';
+export interface IInsertHeaderFooterFieldParams {
+    unitId: string;
+    fieldType: 'PAGE' | 'NUMPAGES' | 'DATE' | 'TIME';
+    selection?: ITextRange;
+    segmentId?: string;
+    segmentPage?: number;
+    expectedDataStream?: string;
+    format?: DateTimeFieldFormat;
+    automatic?: boolean;
+}
+export declare const InsertHeaderFooterFieldCommand: ICommand<IInsertHeaderFooterFieldParams>;

package/lib/types/commands/commands/insert-special-character.command.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 { ICommand } from '@cool-office/core';
+export declare const InsertSpecialCharacterCommand: ICommand<{
+    value: string;
+}>;

package/lib/types/commands/commands/list.command.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { ICommand, IParagraph, IParagraphRange, ISectionBreak } from '@cool-office/core';
+import type { ITextRangeWithStyle } from '@cool-office/engine-render';
+import { PresetListType } from '@cool-office/core';
+interface IListOperationCommandParams {
+    listType: PresetListType;
+    docRange?: ITextRangeWithStyle[];
+}
+export declare const ListOperationCommand: ICommand<IListOperationCommandParams>;
+interface IChangeListTypeCommandParams {
+    listType: PresetListType;
+    docRange?: ITextRangeWithStyle[];
+}
+export declare const ChangeListTypeCommand: ICommand<IChangeListTypeCommandParams>;
+export declare enum ChangeListNestingLevelType {
+    increase = 1,
+    decrease = -1
+}
+interface IChangeListNestingLevelCommandParams {
+    type: ChangeListNestingLevelType;
+}
+export declare const ChangeListNestingLevelCommand: ICommand<IChangeListNestingLevelCommandParams>;
+interface IBulletListCommandParams {
+    value?: PresetListType;
+    docRange?: ITextRangeWithStyle[];
+}
+export declare const BulletListCommand: ICommand<IBulletListCommandParams>;
+export declare const CheckListCommand: ICommand<IBulletListCommandParams>;
+export interface IToggleCheckListCommandParams {
+    index: number;
+    segmentId?: string;
+    textRanges?: ITextRangeWithStyle[];
+}
+export declare const ToggleCheckListCommand: ICommand<IToggleCheckListCommandParams>;
+interface IOrderListCommandParams {
+    value?: PresetListType;
+    docRange?: ITextRangeWithStyle[];
+}
+export declare const OrderListCommand: ICommand<IOrderListCommandParams>;
+interface IQuickListCommandParams {
+    listType: PresetListType;
+    paragraph: IParagraphRange;
+}
+export declare const QuickListCommand: ICommand<IQuickListCommandParams>;
+export declare const InsertBulletListBellowCommand: ICommand<IQuickListCommandParams>;
+export declare const InsertOrderListBellowCommand: ICommand<IQuickListCommandParams>;
+export declare const InsertCheckListBellowCommand: ICommand<IQuickListCommandParams>;
+export declare function getParagraphsRelative(ranges: ITextRangeWithStyle[], paragraphs: IParagraph[], dataStream: string): IParagraph[];
+export declare function findNearestSectionBreak(currentIndex: number, sectionBreaks: ISectionBreak[]): ISectionBreak | undefined;
+export {};

package/lib/types/commands/commands/paragraph-align.command.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+import { HorizontalAlign } from '@cool-office/core';
+interface IAlignOperationCommandParams {
+    alignType: HorizontalAlign;
+}
+export declare const AlignOperationCommand: ICommand<IAlignOperationCommandParams>;
+interface IAlignLeftCommandParams {
+}
+export declare const AlignLeftCommand: ICommand<IAlignLeftCommandParams>;
+interface IAlignCenterCommandParams {
+}
+export declare const AlignCenterCommand: ICommand<IAlignCenterCommandParams>;
+interface IAlignRightCommandParams {
+}
+export declare const AlignRightCommand: ICommand<IAlignRightCommandParams>;
+interface IAlignJustifyCommandParams {
+}
+export declare const AlignJustifyCommand: ICommand<IAlignJustifyCommandParams>;
+export {};

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

@@ -0,0 +1,22 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+export declare const RefreshHeaderFooterFieldsCommand: ICommand<{
+    unitId: string;
+    onOpen?: boolean;
+    selectionOnly?: boolean;
+}>;
+export declare const UpdateSelectedDocFieldsCommand: ICommand;

package/lib/types/commands/commands/replace-content.command.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { ICommand, IDocumentBody, IDocumentData, ITextRange, JSONXActions } from '@cool-office/core';
+import type { ITextRangeWithStyle } from '@cool-office/engine-render';
+export interface IReplaceSnapshotCommandParams {
+    unitId: string;
+    snapshot: IDocumentData;
+    textRanges: ITextRangeWithStyle[];
+    segmentId?: string;
+    options: {
+        [key: string]: boolean;
+    };
+}
+export declare const ReplaceSnapshotCommand: ICommand<IReplaceSnapshotCommandParams>;
+export declare function buildReplaceSnapshotActions(previousSnapshot: IDocumentData, snapshot: IDocumentData): JSONXActions | null;
+interface ICoverContentCommandParams {
+    unitId: string;
+    body: IDocumentBody;
+    segmentId?: string;
+    textRanges?: ITextRangeWithStyle[];
+}
+export declare const CoverContentCommand: ICommand<ICoverContentCommandParams>;
+export interface IReplaceSelectionCommandParams {
+    unitId: string;
+    historyAction?: string;
+    selection?: ITextRange;
+    body: IDocumentBody;
+    textRanges?: ITextRangeWithStyle[];
+    segmentId?: string;
+}
+export declare const ReplaceSelectionCommand: ICommand<IReplaceSelectionCommandParams>;
+interface IReplaceTextRunsCommandParams {
+    unitId: string;
+    body: IDocumentBody;
+    textRanges: ITextRangeWithStyle[];
+    segmentId?: string;
+    options: {
+        [key: string]: boolean;
+    };
+}
+export declare const ReplaceTextRunsCommand: ICommand<IReplaceTextRunsCommandParams>;
+export {};

package/lib/types/commands/commands/set-doc-zoom-ratio.command.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+export interface ISetDocZoomRatioCommandParams {
+    zoomRatio?: number;
+    documentId?: string;
+}
+export declare const SetDocZoomRatioCommand: ICommand;

package/lib/types/commands/commands/set-heading.command.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { ICommand, ITextRangeParam } from '@cool-office/core';
+import { NamedStyleType } from '@cool-office/core';
+export interface ISetParagraphNamedStyleCommandParams {
+    value: NamedStyleType;
+    textRanges?: ITextRangeParam[];
+}
+export declare const SetParagraphNamedStyleCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const QuickHeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const QUICK_HEADING_MAP: {
+    '#': NamedStyleType;
+    '##': NamedStyleType;
+    '###': NamedStyleType;
+    '####': NamedStyleType;
+    '#####': NamedStyleType;
+};
+export declare const H1HeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const H2HeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const H3HeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const H4HeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const H5HeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const NormalTextHeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const TitleHeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;
+export declare const SubtitleHeadingCommand: ICommand<ISetParagraphNamedStyleCommandParams>;

package/lib/types/commands/commands/switch-doc-mode.command.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 { ICommand } from '@cool-office/core';
+export interface ISwitchDocModeCommandParams {
+}
+export declare const SwitchDocModeCommand: ICommand<ISwitchDocModeCommandParams>;