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

package/lib/index.js

@@ -1,4 +1,4 @@
-import { BuildTextUtils, CommandType, DOCS_FORMULA_BAR_EDITOR_UNIT_ID_KEY, DOCS_NORMAL_EDITOR_UNIT_ID_KEY, DeleteDirection, Disposable, DisposableCollection, ICommandService, IConfigService, IUndoRedoService, IUniverInstanceService, Inject, Injector, JSONX, LocaleService, Optional, Plugin, RedoCommandId, RxDisposable, TextX, TextXActionType, UndoCommandId, UniverInstanceType, composeInterceptors, createIdentifier, createInterceptorKey, getRichTextEditPath, isInternalEditorID, merge, remove, toDisposable } from "@univerjs/core";
+import { BuildTextUtils, CommandType, DOCS_FORMULA_BAR_EDITOR_UNIT_ID_KEY, DOCS_NORMAL_EDITOR_UNIT_ID_KEY, DeleteDirection, Disposable, DisposableCollection, DocumentFlavor, ICommandService, IConfigService, IUndoRedoService, IUniverInstanceService, Inject, Injector, JSONX, LocaleService, Optional, Plugin, RedoCommandId, RxDisposable, TextX, TextXActionType, UndoCommandId, UniverInstanceType, composeInterceptors, createIdentifier, createInterceptorKey, createParagraphId, generateRandomId, getRichTextEditPath, isInternalEditorID, merge, remove, toDisposable } from "@univerjs/core";
 import { DocumentSkeleton, DocumentViewModel, IRenderManagerService, NORMAL_TEXT_SELECTION_PLUGIN_STYLE } from "@univerjs/engine-render";
 import { BehaviorSubject, Subject, takeUntil } from "rxjs";
 
@@ -386,14 +386,14 @@ const InsertTextCommand = {
 	id: "doc.command.insert-text",
 	type: CommandType.COMMAND,
 	handler: (accessor, params) => {
-		var _activeRange$segmentI;
+		var _docDataModel$getSelf, _activeRange$segmentI;
 		const commandService = accessor.get(ICommandService);
 		const { range, segmentId, body, unitId, cursorOffset } = params;
 		const docSelectionManagerService = accessor.get(DocSelectionManagerService);
 		const docDataModel = accessor.get(IUniverInstanceService).getUnit(unitId, UniverInstanceType.UNIVER_DOC);
 		if (docDataModel == null) return false;
 		const activeRange = docSelectionManagerService.getActiveTextRange();
-		const originBody = docDataModel.getSelfOrHeaderFooterModel((_activeRange$segmentI = activeRange === null || activeRange === void 0 ? void 0 : activeRange.segmentId) !== null && _activeRange$segmentI !== void 0 ? _activeRange$segmentI : "").getBody();
+		const originBody = (_docDataModel$getSelf = docDataModel.getSelfOrHeaderFooterModel((_activeRange$segmentI = activeRange === null || activeRange === void 0 ? void 0 : activeRange.segmentId) !== null && _activeRange$segmentI !== void 0 ? _activeRange$segmentI : "")) === null || _docDataModel$getSelf === void 0 ? void 0 : _docDataModel$getSelf.getBody();
 		if (originBody == null) return false;
 		const { startOffset, collapsed } = range;
 		const cursorMove = cursorOffset !== null && cursorOffset !== void 0 ? cursorOffset : body.dataStream.length;
@@ -446,12 +446,12 @@ const DeleteTextCommand = {
 	id: "doc.command.delete-text",
 	type: CommandType.COMMAND,
 	handler: (accessor, params) => {
-		var _body$customRanges;
+		var _docDataModel$getSelf2, _body$customRanges;
 		const commandService = accessor.get(ICommandService);
 		const univerInstanceService = accessor.get(IUniverInstanceService);
 		const { range, segmentId, unitId, direction, len = 1 } = params;
 		const docDataModel = univerInstanceService.getUnit(unitId, UniverInstanceType.UNIVER_DOC);
-		const body = docDataModel === null || docDataModel === void 0 ? void 0 : docDataModel.getSelfOrHeaderFooterModel(segmentId).getBody();
+		const body = docDataModel === null || docDataModel === void 0 || (_docDataModel$getSelf2 = docDataModel.getSelfOrHeaderFooterModel(segmentId)) === null || _docDataModel$getSelf2 === void 0 ? void 0 : _docDataModel$getSelf2.getBody();
 		if (docDataModel == null || body == null) return false;
 		const { startOffset } = range;
 		let start = direction === DeleteDirection.LEFT ? startOffset - len : startOffset;
@@ -499,7 +499,7 @@ const UpdateTextCommand = {
 	handler: (accessor, params) => {
 		const { range, segmentId, updateBody, coverType, unitId, textRanges } = params;
 		const commandService = accessor.get(ICommandService);
-		const docDataModel = accessor.get(IUniverInstanceService).getCurrentUniverDocInstance();
+		const docDataModel = accessor.get(IUniverInstanceService).getCurrentUnitOfType(UniverInstanceType.UNIVER_DOC);
 		if (docDataModel == null) return false;
 		const doMutation = {
 			id: RichTextEditingMutation.id,
@@ -529,10 +529,141 @@ const UpdateTextCommand = {
 	}
 };
 
+//#endregion
+//#region src/commands/commands/create-header-footer.command.ts
+let HeaderFooterType = /* @__PURE__ */ function(HeaderFooterType) {
+	HeaderFooterType[HeaderFooterType["FIRST_PAGE_HEADER"] = 0] = "FIRST_PAGE_HEADER";
+	HeaderFooterType[HeaderFooterType["FIRST_PAGE_FOOTER"] = 1] = "FIRST_PAGE_FOOTER";
+	HeaderFooterType[HeaderFooterType["DEFAULT_HEADER"] = 2] = "DEFAULT_HEADER";
+	HeaderFooterType[HeaderFooterType["DEFAULT_FOOTER"] = 3] = "DEFAULT_FOOTER";
+	HeaderFooterType[HeaderFooterType["EVEN_PAGE_HEADER"] = 4] = "EVEN_PAGE_HEADER";
+	HeaderFooterType[HeaderFooterType["EVEN_PAGE_FOOTER"] = 5] = "EVEN_PAGE_FOOTER";
+	return HeaderFooterType;
+}({});
+function getEmptyHeaderFooterBody() {
+	return {
+		dataStream: "\r\n",
+		textRuns: [{
+			st: 0,
+			ed: 0,
+			ts: { fs: 9 }
+		}],
+		customBlocks: [],
+		paragraphs: [{
+			startIndex: 0,
+			paragraphId: createParagraphId(/* @__PURE__ */ new Set()),
+			paragraphStyle: {
+				spaceAbove: { v: 0 },
+				lineSpacing: 1.5,
+				spaceBelow: { v: 0 }
+			}
+		}],
+		sectionBreaks: [{ startIndex: 1 }]
+	};
+}
+function createHeaderFooterAction(segmentId, createType, documentStyle, actions, createMode = "single") {
+	const jsonX = JSONX.getInstance();
+	const ID_LEN = 6;
+	const firstSegmentId = segmentId !== null && segmentId !== void 0 ? segmentId : generateRandomId(ID_LEN);
+	const isHeader = createType === 2 || createType === 0 || createType === 4;
+	const insertAction = jsonX.insertOp([isHeader ? "headers" : "footers", firstSegmentId], {
+		[isHeader ? "headerId" : "footerId"]: firstSegmentId,
+		body: getEmptyHeaderFooterBody()
+	});
+	actions.push(insertAction);
+	let key = "defaultHeaderId";
+	let pairKey = "defaultFooterId";
+	switch (createType) {
+		case 2:
+			key = "defaultHeaderId";
+			pairKey = "defaultFooterId";
+			break;
+		case 3:
+			key = "defaultFooterId";
+			pairKey = "defaultHeaderId";
+			break;
+		case 0:
+			key = "firstPageHeaderId";
+			pairKey = "firstPageFooterId";
+			break;
+		case 1:
+			key = "firstPageFooterId";
+			pairKey = "firstPageHeaderId";
+			break;
+		case 4:
+			key = "evenPageHeaderId";
+			pairKey = "evenPageFooterId";
+			break;
+		case 5:
+			key = "evenPageFooterId";
+			pairKey = "evenPageHeaderId";
+			break;
+		default: throw new Error(`Unknown header footer type: ${createType}`);
+	}
+	const linkedSegmentIds = [[key, firstSegmentId]];
+	if (createMode === "pair" && pairKey != null) {
+		const secondSegmentId = generateRandomId(ID_LEN);
+		const insertPairAction = jsonX.insertOp([isHeader ? "footers" : "headers", secondSegmentId], {
+			[isHeader ? "footerId" : "headerId"]: secondSegmentId,
+			body: getEmptyHeaderFooterBody()
+		});
+		actions.push(insertPairAction);
+		linkedSegmentIds.push([pairKey, secondSegmentId]);
+	}
+	for (const [k, id] of linkedSegmentIds) if (documentStyle[k] != null) {
+		const replaceAction = jsonX.replaceOp(["documentStyle", k], documentStyle[k], id);
+		actions.push(replaceAction);
+	} else {
+		const insertAction = jsonX.insertOp(["documentStyle", k], id);
+		actions.push(insertAction);
+	}
+	return actions;
+}
+const CreateHeaderFooterCommand = {
+	id: "doc.command.create-header-footer",
+	type: CommandType.COMMAND,
+	handler: (accessor, params) => {
+		const commandService = accessor.get(ICommandService);
+		const univerInstanceService = accessor.get(IUniverInstanceService);
+		const { unitId, segmentId, createType, headerFooterProps, createMode = "single" } = params;
+		const docDataModel = univerInstanceService.getUnit(unitId, UniverInstanceType.UNIVER_DOC);
+		if (docDataModel == null) return false;
+		const { documentStyle } = docDataModel.getSnapshot();
+		if (documentStyle.documentFlavor === DocumentFlavor.MODERN) return false;
+		const rawActions = [];
+		const jsonX = JSONX.getInstance();
+		if (createType != null) createHeaderFooterAction(segmentId, createType, documentStyle, rawActions, createMode);
+		if (headerFooterProps != null) Object.keys(headerFooterProps).forEach((key) => {
+			const value = headerFooterProps[key];
+			const oldValue = documentStyle[key];
+			if (value === oldValue) return;
+			const action = oldValue === void 0 ? jsonX.insertOp(["documentStyle", key], value) : jsonX.replaceOp(["documentStyle", key], oldValue, value);
+			rawActions.push(action);
+		});
+		if (rawActions.length === 0) return false;
+		const doMutation = {
+			id: RichTextEditingMutation.id,
+			params: {
+				unitId,
+				actions: rawActions.reduce((acc, cur) => JSONX.compose(acc, cur), null),
+				textRanges: [{
+					startOffset: 0,
+					endOffset: 0,
+					collapsed: true
+				}],
+				debounce: true
+			}
+		};
+		if ((headerFooterProps === null || headerFooterProps === void 0 ? void 0 : headerFooterProps.marginFooter) != null || (headerFooterProps === null || headerFooterProps === void 0 ? void 0 : headerFooterProps.marginHeader) != null) doMutation.params.noNeedSetTextRange = true;
+		const result = commandService.syncExecuteCommand(doMutation.id, doMutation.params);
+		return Boolean(result);
+	}
+};
+
 //#endregion
 //#region package.json
 var name = "@univerjs/docs";
-var version = "1.0.0-alpha.0";
+var version = "1.0.0-alpha.2";
 
 //#endregion
 //#region src/commands/mutations/docs-rename.mutation.ts
@@ -621,6 +752,33 @@ DocCustomRangeController = __decorate([
 	__decorateParam(2, IUniverInstanceService)
 ], DocCustomRangeController);
 
+//#endregion
+//#region src/services/doc-block-move-validator.service.ts
+var DocBlockMoveValidatorService = class extends Disposable {
+	constructor(..._args) {
+		super(..._args);
+		_defineProperty(this, "_validators", []);
+		_defineProperty(this, "_transformers", []);
+	}
+	registerValidator(validator) {
+		this._validators.push(validator);
+		return this.disposeWithMe(toDisposable(() => remove(this._validators, validator)));
+	}
+	registerTransformer(transformer) {
+		this._transformers.push(transformer);
+		return this.disposeWithMe(toDisposable(() => remove(this._transformers, transformer)));
+	}
+	canMoveBlock(context) {
+		return this._validators.every((validator) => validator(context));
+	}
+	transformMoveResult(context) {
+		return this._transformers.reduce((result, transformer) => transformer({
+			...context,
+			result
+		}), context.result);
+	}
+};
+
 //#endregion
 //#region src/services/doc-content-insert.service.ts
 /**
@@ -697,7 +855,7 @@ let DocStateChangeManagerService = class DocStateChangeManagerService extends Rx
 	_initialize() {
 		this.disposeWithMe(this._commandService.beforeCommandExecuted((command) => {
 			if (command.id === UndoCommandId || command.id === RedoCommandId) {
-				const univerDoc = this._univerInstanceService.getCurrentUniverDocInstance();
+				const univerDoc = this._univerInstanceService.getCurrentUnitOfType(UniverInstanceType.UNIVER_DOC);
 				if (univerDoc == null) return;
 				const unitId = univerDoc.getUnitId();
 				this._pushHistory(unitId);
@@ -827,6 +985,7 @@ let UniverDocsPlugin = class UniverDocsPlugin extends Plugin {
 			InsertTextCommand,
 			DeleteTextCommand,
 			UpdateTextCommand,
+			CreateHeaderFooterCommand,
 			RichTextEditingMutation,
 			DocsRenameMutation,
 			SetTextSelectionsOperation
@@ -839,6 +998,7 @@ let UniverDocsPlugin = class UniverDocsPlugin extends Plugin {
 			[DocSelectionManagerService],
 			[DocStateEmitService],
 			[DocStateChangeManagerService],
+			[DocBlockMoveValidatorService],
 			[DocContentInsertService],
 			[DocCustomRangeController]
 		].forEach((d) => this._injector.add(d));
@@ -955,7 +1115,7 @@ function addCustomRangeFactory(accessor, param, body) {
 	return doMutation;
 }
 function addCustomRangeBySelectionFactory(accessor, param) {
-	var _selections$;
+	var _selections$, _documentDataModel$ge;
 	const { rangeId, rangeType, wholeEntity, properties, unitId, selections: propSelection } = param;
 	const docSelectionManagerService = accessor.get(DocSelectionManagerService);
 	const univerInstanceService = accessor.get(IUniverInstanceService);
@@ -967,7 +1127,7 @@ function addCustomRangeBySelectionFactory(accessor, param) {
 	if (!(selections === null || selections === void 0 ? void 0 : selections.length)) return false;
 	const documentDataModel = univerInstanceService.getUnit(unitId, UniverInstanceType.UNIVER_DOC);
 	if (!documentDataModel) return false;
-	const body = documentDataModel.getSelfOrHeaderFooterModel(segmentId).getBody();
+	const body = (_documentDataModel$ge = documentDataModel.getSelfOrHeaderFooterModel(segmentId)) === null || _documentDataModel$ge === void 0 ? void 0 : _documentDataModel$ge.getBody();
 	if (!body) return false;
 	const textX = BuildTextUtils.customRange.add({
 		ranges: selections,
@@ -1064,4 +1224,17 @@ function replaceSelectionFactory(accessor, params) {
 }
 
 //#endregion
-export { DOC_INTERCEPTOR_POINT, DeleteTextCommand, DocContentInsertService, DocInterceptorService, DocSelectionManagerService, DocSkeletonManagerService, DocStateChangeManagerService, DocStateEmitService, IDocStateChangeInterceptorService, InsertTextCommand, RichTextEditingMutation, SetTextSelectionsOperation, UniverDocsPlugin, UpdateTextCommand, addCustomRangeBySelectionFactory, addCustomRangeFactory, deleteCustomRangeFactory, replaceSelectionFactory };
+//#region src/utils/util.ts
+function consumeContentInsertRange(accessor, unitId) {
+	try {
+		return accessor.get(DocContentInsertService).consumeInsertRange(unitId);
+	} catch {
+		return null;
+	}
+}
+function isHeaderFooterSelection(range) {
+	return Boolean(range === null || range === void 0 ? void 0 : range.segmentId);
+}
+
+//#endregion
+export { CreateHeaderFooterCommand, DOC_INTERCEPTOR_POINT, DeleteTextCommand, DocBlockMoveValidatorService, DocContentInsertService, DocInterceptorService, DocSelectionManagerService, DocSkeletonManagerService, DocStateChangeManagerService, DocStateEmitService, HeaderFooterType, IDocStateChangeInterceptorService, InsertTextCommand, RichTextEditingMutation, SetTextSelectionsOperation, UniverDocsPlugin, UpdateTextCommand, addCustomRangeBySelectionFactory, addCustomRangeFactory, consumeContentInsertRange, deleteCustomRangeFactory, isHeaderFooterSelection, replaceSelectionFactory };

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

@@ -0,0 +1,41 @@
+/**
+ * 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 { BooleanNumber, ICommand, IDocumentBody, JSONXActions } from '@univerjs/core';
+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 interface IHeaderFooterProps {
+    marginHeader?: number;
+    marginFooter?: number;
+    useFirstPageHeaderFooter?: BooleanNumber;
+    evenAndOddHeaders?: BooleanNumber;
+}
+export type HeaderFooterCreateMode = 'single' | 'pair';
+export interface ICreateHeaderFooterCommandParams {
+    unitId: string;
+    createType?: HeaderFooterType;
+    segmentId?: string;
+    headerFooterProps?: IHeaderFooterProps;
+    createMode?: HeaderFooterCreateMode;
+}
+export declare function getEmptyHeaderFooterBody(): IDocumentBody;
+export declare function createHeaderFooterAction(segmentId: string | undefined, createType: HeaderFooterType, documentStyle: IHeaderFooterProps, actions: JSONXActions, createMode?: HeaderFooterCreateMode): JSONXActions;
+export declare const CreateHeaderFooterCommand: ICommand<ICreateHeaderFooterCommandParams>;

package/lib/types/facade/f-document-paragraph.d.ts

@@ -0,0 +1,204 @@
+/**
+ * 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 { Injector, IParagraph, IParagraphStyle } from '@univerjs/core';
+import type { FDocument } from './f-document';
+import type { IFDocumentTextRange } from './utils';
+/**
+ * Resolved paragraph metadata in the the document body.
+ */
+export interface IFDocumentParagraphInfo {
+    /** The underlying paragraph snapshot object. */
+    paragraph: IParagraph;
+    /** The current paragraph index in the body paragraph list. */
+    paragraphIndex: number;
+    /** The inclusive start offset of the paragraph text. */
+    startOffset: number;
+    /** The exclusive end offset of the paragraph text, before the paragraph break. */
+    endOffset: number;
+}
+/**
+ * A paragraph facade wrapper.
+ *
+ * Paragraph identity is backed by the persisted `paragraphId`. The id is
+ * re-resolved before each method call, so insertions before this paragraph do
+ * not break the wrapper.
+ *
+ * @hideconstructor
+ */
+export declare class FDocumentParagraph {
+    private readonly _document;
+    private readonly _paragraphId;
+    private readonly _segmentId;
+    private readonly _injector;
+    constructor(_document: FDocument, _paragraphId: string, _segmentId: string | undefined, _injector: Injector);
+    /**
+     * Get the persisted paragraph id.
+     * @returns {string} The paragraph id.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * console.log(paragraph?.getId());
+     * ```
+     */
+    getId(): string;
+    /**
+     * Get the segment id of this paragraph.
+     * The main body paragraphs have an empty string segment id.
+     * The header and footer paragraphs have a non-empty string segment id.
+     * @returns {string} The segment id.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * console.log(paragraph?.getSegmentId());
+     * ```
+     */
+    getSegmentId(): string;
+    /**
+     * Get this paragraph's metadata.
+     * @returns {IFDocumentParagraphInfo} The paragraph info.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * console.log(paragraph?.getInfo());
+     * ```
+     */
+    getInfo(): IFDocumentParagraphInfo;
+    /**
+     * Get the current text range occupied by this paragraph.
+     * @returns {IFDocumentTextRange} The paragraph text range, excluding the trailing paragraph break.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * console.log(paragraph?.getRange());
+     * ```
+     */
+    getRange(): IFDocumentTextRange;
+    /**
+     * Get this paragraph's plain text.
+     * @returns {string} The paragraph text without the trailing paragraph break.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * console.log(paragraph?.getText());
+     * ```
+     */
+    getText(): string;
+    /**
+     * Replace this paragraph's plain text.
+     * @param {string} text The replacement text. Do not include the paragraph break.
+     * @returns {boolean} `true` if the paragraph text was replaced.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * paragraph?.setText('New text');
+     * console.log(paragraph?.getText());
+     * ```
+     */
+    setText(text: string): boolean;
+    /**
+     * Append plain text before this paragraph's trailing paragraph break.
+     * @param {string} text The plain text to append.
+     * @returns {boolean} `true` if the text was appended.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * paragraph?.appendText(' Appended text');
+     * console.log(paragraph?.getText());
+     * ```
+     */
+    appendText(text: string): boolean;
+    /**
+     * Apply paragraph style to a paragraph handle or text range.
+     * @param {IParagraphStyle} style The Univer paragraph style patch.
+     * @returns {boolean} `true` if the style was applied.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * paragraph?.setText('Styled text');
+     * paragraph?.setStyle({
+     *   textStyle: {
+     *     cl: {
+     *       rgb: '#FF0000',
+     *     },
+     *     fs: 14,
+     *   },
+     *   horizontalAlign: 2,
+     * });
+     * console.log(paragraph?.getInfo().paragraph.paragraphStyle);
+     * ```
+     */
+    setStyle(style: IParagraphStyle): boolean;
+    /**
+     * Check whether this paragraph is a bullet, ordered, or checklist item.
+     * @returns {boolean} `true` if the paragraph has list metadata.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * console.log(paragraph?.isListItem());
+     * ```
+     */
+    isListItem(): boolean;
+    /**
+     * Check whether this paragraph is a task/checklist item.
+     * @returns {boolean} `true` if this paragraph is an unchecked or checked task item.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * console.log(paragraph?.isTask());
+     * ```
+     */
+    isTask(): boolean;
+    /**
+     * Set the checked state of this task/checklist paragraph.
+     * @param {boolean} checked Whether the task item should be checked.
+     * @returns {boolean} `true` if the task state was updated, or `false` if this paragraph is not a task item.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     *
+     * if (paragraph.isTask()) {
+     *   const success = paragraph.setTaskChecked(true);
+     *   console.log(success ? 'Task checked' : 'Failed to check task');
+     * }
+     * ```
+     */
+    setTaskChecked(checked: boolean): boolean;
+    /**
+     * Remove this paragraph.
+     * @returns {boolean} `true` if the paragraph was removed.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraphs()[0];
+     * const success = paragraph?.remove();
+     * console.log(success ? 'Paragraph removed' : 'Failed to remove paragraph');
+     * ```
+     */
+    remove(): boolean;
+    private _preserveExplicitParagraphIds;
+}
+export declare function isParagraphFacade(value: unknown): value is FDocumentParagraph;