@univerjs/docs-toc 1.0.0

package/lib/index.js

@@ -0,0 +1,583 @@
+import { BooleanNumber, BuildTextUtils, CommandType, CustomRangeType, DependentOn, ICommandService, IConfigService, IUndoRedoService, IUniverInstanceService, Inject, Injector, JSONX, NamedStyleType, Plugin, SliceBodyType, TabStopAlignment, TabStopLeader, TextX, Tools, UniverInstanceType, cloneParagraphWithId, createParagraphId, generateRandomId, getBodySlice, getPlainText, getRichTextEditPath, merge } from "@univerjs/core";
+import { DocSelectionManagerService, DocSkeletonManagerService, DocStateChangeManagerService, RichTextEditingMutation, UniverDocsPlugin } from "@univerjs/docs";
+import { IRenderManagerService, UniverRenderEnginePlugin } from "@univerjs/engine-render";
+import { filter, firstValueFrom, take, timeout } from "rxjs";
+
+//#region src/commands/table-of-contents.command.ts
+const FIELD_START = "";
+const FIELD_END = "";
+async function replaceBodyRange(accessor, doc, unitId, selection, body, historyAction, historyGroupId = generateRandomId()) {
+	const textX = new TextX();
+	textX.push(...BuildTextUtils.selection.delete([selection], doc.getBody(), 0, body));
+	const caretOffset = selection.startOffset + body.dataStream.length;
+	accessor.get(DocStateChangeManagerService).flushPendingChanges(unitId);
+	const group = accessor.get(IUndoRedoService).beginUndoRedoGroup(unitId, historyGroupId, "append");
+	try {
+		return Boolean(accessor.get(ICommandService).syncExecuteCommand(RichTextEditingMutation.id, {
+			unitId,
+			historyAction,
+			actions: JSONX.getInstance().editOp(textX.serialize(), getRichTextEditPath(doc)),
+			textRanges: [{
+				startOffset: caretOffset,
+				endOffset: caretOffset,
+				collapsed: true
+			}],
+			debounce: false,
+			trigger: historyAction
+		}));
+	} finally {
+		group.dispose();
+	}
+}
+const UpdateTableOfContentsCommand = {
+	id: "doc.command.update-table-of-contents",
+	type: CommandType.COMMAND,
+	handler: (accessor, params) => updateTableOfContents(accessor, params)
+};
+async function updateTableOfContents(accessor, params, historyGroupId = generateRandomId()) {
+	var _body$customRanges, _toc$properties, _render$getInjector;
+	const instanceService = accessor.get(IUniverInstanceService);
+	const doc = (params === null || params === void 0 ? void 0 : params.unitId) ? instanceService.getUnit(params.unitId, UniverInstanceType.UNIVER_DOC) : instanceService.getCurrentUnitOfType(UniverInstanceType.UNIVER_DOC);
+	const body = doc === null || doc === void 0 ? void 0 : doc.getBody();
+	const selection = accessor.get(DocSelectionManagerService).getActiveTextRange();
+	const toc = (params === null || params === void 0 ? void 0 : params.rangeId) ? body === null || body === void 0 || (_body$customRanges = body.customRanges) === null || _body$customRanges === void 0 ? void 0 : _body$customRanges.find((range) => range.rangeId === params.rangeId && isTableOfContentsRange(range)) : findTableOfContentsAtOffset(body, selection === null || selection === void 0 ? void 0 : selection.startOffset);
+	const unitId = doc === null || doc === void 0 ? void 0 : doc.getUnitId();
+	if (!doc || !body || !toc || ((_toc$properties = toc.properties) === null || _toc$properties === void 0 ? void 0 : _toc$properties.locked) === BooleanNumber.TRUE || !unitId) return false;
+	const render = accessor.get(IRenderManagerService).getRenderUnitById(unitId);
+	const renderInjector = render === null || render === void 0 || (_render$getInjector = render.getInjector) === null || _render$getInjector === void 0 ? void 0 : _render$getInjector.call(render);
+	if (!render || !(renderInjector === null || renderInjector === void 0 ? void 0 : renderInjector.has(DocSkeletonManagerService))) return false;
+	const skeleton = render.with(DocSkeletonManagerService).getSkeleton();
+	if (!await waitForCompleteLayout(skeleton)) return false;
+	let updated = false;
+	for (let iteration = 0; iteration < 3; iteration += 1) {
+		var _currentBody$customRa, _currentToc$propertie, _skeleton$getLayoutPr;
+		const currentBody = doc.getBody();
+		const currentToc = currentBody === null || currentBody === void 0 || (_currentBody$customRa = currentBody.customRanges) === null || _currentBody$customRa === void 0 ? void 0 : _currentBody$customRa.find((range) => range.rangeId === toc.rangeId && isTableOfContentsRange(range));
+		if (!currentBody || !currentToc || ((_currentToc$propertie = currentToc.properties) === null || _currentToc$propertie === void 0 ? void 0 : _currentToc$propertie.locked) === BooleanNumber.TRUE) return false;
+		const resolvePageNumber = (offset) => {
+			var _skeleton$getSkeleton;
+			const pageIndex = skeleton.findBodyPageIndexByCharIndex(offset);
+			return (_skeleton$getSkeleton = skeleton.getSkeletonData()) === null || _skeleton$getSkeleton === void 0 || (_skeleton$getSkeleton = _skeleton$getSkeleton.pages[pageIndex]) === null || _skeleton$getSkeleton === void 0 ? void 0 : _skeleton$getSkeleton.pageNumber;
+		};
+		const replacement = (params === null || params === void 0 ? void 0 : params.mode) === "pageNumbersOnly" ? buildPageNumberOnlyTableOfContentsBody(currentBody, currentToc, resolvePageNumber) : buildTableOfContentsBody(currentBody, currentToc, resolvePageNumber);
+		if (!replacement) return false;
+		if ((params === null || params === void 0 ? void 0 : params.mode) === "pageNumbersOnly" && Tools.diffValue(getBodySlice(currentBody, currentToc.startIndex, currentToc.endIndex + 1, true, SliceBodyType.cut), replacement)) return true;
+		if (updated && currentBody.dataStream.slice(currentToc.startIndex, currentToc.endIndex + 1) === replacement.dataStream) return true;
+		const generation = ((_skeleton$getLayoutPr = skeleton.getLayoutProgress()) === null || _skeleton$getLayoutPr === void 0 ? void 0 : _skeleton$getLayoutPr.generation) ?? -1;
+		updated = await replaceBodyRange(accessor, doc, unitId, {
+			startOffset: currentToc.startIndex,
+			endOffset: currentToc.endIndex + 1,
+			collapsed: false
+		}, replacement, UpdateTableOfContentsCommand.id, historyGroupId);
+		if (!updated || iteration === 2) return updated;
+		if (!await waitForNextCompleteLayout(skeleton, generation)) return false;
+	}
+	return updated;
+}
+const DeleteTableOfContentsCommand = {
+	id: "doc.command.delete-table-of-contents",
+	type: CommandType.COMMAND,
+	async handler(accessor, params) {
+		var _body$customRanges2;
+		const instanceService = accessor.get(IUniverInstanceService);
+		const doc = (params === null || params === void 0 ? void 0 : params.unitId) ? instanceService.getUnit(params.unitId, UniverInstanceType.UNIVER_DOC) : instanceService.getCurrentUnitOfType(UniverInstanceType.UNIVER_DOC);
+		const body = doc === null || doc === void 0 ? void 0 : doc.getBody();
+		const selection = accessor.get(DocSelectionManagerService).getActiveTextRange();
+		const toc = (params === null || params === void 0 ? void 0 : params.rangeId) ? body === null || body === void 0 || (_body$customRanges2 = body.customRanges) === null || _body$customRanges2 === void 0 ? void 0 : _body$customRanges2.find((range) => range.rangeId === params.rangeId && isTableOfContentsRange(range)) : findTableOfContentsAtOffset(body, selection === null || selection === void 0 ? void 0 : selection.startOffset);
+		const unitId = doc === null || doc === void 0 ? void 0 : doc.getUnitId();
+		if (!toc || !unitId) return false;
+		return replaceBodyRange(accessor, doc, unitId, {
+			startOffset: toc.startIndex,
+			endOffset: toc.endIndex + 1,
+			collapsed: false
+		}, { dataStream: "" }, DeleteTableOfContentsCommand.id);
+	}
+};
+const InsertTableOfContentsCommand = {
+	id: "doc.command.insert-table-of-contents",
+	type: CommandType.COMMAND,
+	async handler(accessor, params) {
+		var _render$getInjector2;
+		const instanceService = accessor.get(IUniverInstanceService);
+		const doc = (params === null || params === void 0 ? void 0 : params.unitId) ? instanceService.getUnit(params.unitId, UniverInstanceType.UNIVER_DOC) : instanceService.getCurrentUnitOfType(UniverInstanceType.UNIVER_DOC);
+		const selection = accessor.get(DocSelectionManagerService).getActiveTextRange();
+		const body = doc === null || doc === void 0 ? void 0 : doc.getBody();
+		const unitId = doc === null || doc === void 0 ? void 0 : doc.getUnitId();
+		const render = unitId ? accessor.get(IRenderManagerService).getRenderUnitById(unitId) : void 0;
+		const renderInjector = render === null || render === void 0 || (_render$getInjector2 = render.getInjector) === null || _render$getInjector2 === void 0 ? void 0 : _render$getInjector2.call(render);
+		if (!doc || !body || !unitId || !selection || selection.segmentId || selection.startOffset !== selection.endOffset || findTableOfContentsAtOffset(body, selection.startOffset) || !render || !(renderInjector === null || renderInjector === void 0 ? void 0 : renderInjector.has(DocSkeletonManagerService))) return false;
+		const skeleton = render.with(DocSkeletonManagerService).getSkeleton();
+		if (!await waitForCompleteLayout(skeleton)) return false;
+		const levels = Math.min(9, Math.max(1, Math.trunc((params === null || params === void 0 ? void 0 : params.levels) ?? 3)));
+		const showPageNumbers = (params === null || params === void 0 ? void 0 : params.showPageNumbers) ?? true;
+		const rightAlignPageNumbers = showPageNumbers && ((params === null || params === void 0 ? void 0 : params.rightAlignPageNumbers) ?? true);
+		const tabLeader = (params === null || params === void 0 ? void 0 : params.tabLeader) ?? "dots";
+		const format = (params === null || params === void 0 ? void 0 : params.format) ?? "fromTemplate";
+		const rangeId = generateRandomId();
+		const toc = {
+			rangeId,
+			rangeType: CustomRangeType.FIELD,
+			startIndex: selection.startOffset,
+			endIndex: selection.startOffset,
+			wholeEntity: false,
+			properties: {
+				fieldType: "TOC",
+				instruction: buildTableOfContentsInstruction({
+					levels,
+					showPageNumbers,
+					rightAlignPageNumbers
+				}),
+				sourceKind: "complex",
+				showPageNumbers,
+				rightAlignPageNumbers,
+				tabLeader,
+				format,
+				title: params === null || params === void 0 ? void 0 : params.title
+			}
+		};
+		const { pageSize, marginLeft = 0, marginRight = 0 } = doc.getDocumentStyle();
+		const replacement = buildTableOfContentsBody(body, toc, (offset) => {
+			var _skeleton$getSkeleton2;
+			const pageIndex = skeleton.findBodyPageIndexByCharIndex(offset);
+			return (_skeleton$getSkeleton2 = skeleton.getSkeletonData()) === null || _skeleton$getSkeleton2 === void 0 || (_skeleton$getSkeleton2 = _skeleton$getSkeleton2.pages[pageIndex]) === null || _skeleton$getSkeleton2 === void 0 ? void 0 : _skeleton$getSkeleton2.pageNumber;
+		}, generateRandomId, { tabStopOffset: Math.max(72, ((pageSize === null || pageSize === void 0 ? void 0 : pageSize.width) ?? 594.3) - marginLeft - marginRight) });
+		if (!replacement) return false;
+		const historyGroupId = generateRandomId();
+		if (!await replaceBodyRange(accessor, doc, unitId, {
+			startOffset: selection.startOffset,
+			endOffset: selection.startOffset,
+			collapsed: true
+		}, replacement, InsertTableOfContentsCommand.id, historyGroupId)) return false;
+		await updateTableOfContents(accessor, {
+			unitId,
+			rangeId,
+			mode: "entireTable"
+		}, historyGroupId);
+		return true;
+	}
+};
+function buildTableOfContentsInstruction(options = {}) {
+	const levels = Math.min(9, Math.max(1, Math.trunc(options.levels ?? 3)));
+	const showPageNumbers = options.showPageNumbers ?? true;
+	const rightAlignPageNumbers = showPageNumbers && (options.rightAlignPageNumbers ?? true);
+	return `TOC ${[
+		`\\o "1-${levels}"`,
+		"\\h",
+		"\\z",
+		"\\u",
+		...!showPageNumbers ? ["\\n"] : [],
+		...showPageNumbers && !rightAlignPageNumbers ? ["\\p \" \""] : []
+	].join(" ")}`;
+}
+function isTableOfContentsRange(range) {
+	var _range$properties;
+	return range.rangeType === CustomRangeType.FIELD && ((_range$properties = range.properties) === null || _range$properties === void 0 ? void 0 : _range$properties.fieldType) === "TOC";
+}
+function findTableOfContentsAtOffset(body, offset) {
+	var _body$customRanges3;
+	if (offset == null) return;
+	return body === null || body === void 0 || (_body$customRanges3 = body.customRanges) === null || _body$customRanges3 === void 0 ? void 0 : _body$customRanges3.filter((range) => isTableOfContentsRange(range) && range.startIndex <= offset && offset <= range.endIndex).sort((left, right) => left.endIndex - left.startIndex - (right.endIndex - right.startIndex))[0];
+}
+async function waitForCompleteLayout(skeleton) {
+	const progress = skeleton.getLayoutProgress();
+	if (progress == null || progress.complete) return true;
+	try {
+		await firstValueFrom(skeleton.layoutProgress$.pipe(filter((next) => next.complete), take(1), timeout({ first: 3e4 })));
+		return true;
+	} catch {
+		return false;
+	}
+}
+async function waitForNextCompleteLayout(skeleton, generation) {
+	try {
+		await firstValueFrom(skeleton.layoutProgress$.pipe(filter((next) => next.generation > generation && next.complete), take(1), timeout({ first: 3e4 })));
+		return true;
+	} catch {
+		return false;
+	}
+}
+function buildPageNumberOnlyTableOfContentsBody(body, toc, resolvePageNumber) {
+	var _toc$properties2, _result$customRanges, _result$customRanges2;
+	if (((_toc$properties2 = toc.properties) === null || _toc$properties2 === void 0 ? void 0 : _toc$properties2.locked) === BooleanNumber.TRUE) return null;
+	const result = Tools.deepClone(getBodySlice(body, toc.startIndex, toc.endIndex + 1, true, SliceBodyType.cut));
+	const pageFields = ((_result$customRanges = result.customRanges) === null || _result$customRanges === void 0 ? void 0 : _result$customRanges.filter((range) => {
+		var _range$properties2, _range$properties3;
+		return range.rangeType === CustomRangeType.FIELD && ((_range$properties2 = range.properties) === null || _range$properties2 === void 0 ? void 0 : _range$properties2.fieldType) === "PAGEREF" && ((_range$properties3 = range.properties) === null || _range$properties3 === void 0 ? void 0 : _range$properties3.locked) !== BooleanNumber.TRUE;
+	}).sort((left, right) => right.startIndex - left.startIndex)) ?? [];
+	for (const pageField of pageFields) {
+		var _body$customRanges4;
+		const originalField = (_body$customRanges4 = body.customRanges) === null || _body$customRanges4 === void 0 ? void 0 : _body$customRanges4.find((range) => range.rangeId === pageField.rangeId);
+		const targetOffset = originalField && resolvePageReferenceOffset(body, originalField);
+		const pageNumber = targetOffset == null ? void 0 : resolvePageNumber(targetOffset);
+		if (pageNumber == null) return null;
+		replaceFieldResult(result, pageField, String(pageNumber));
+	}
+	const outer = (_result$customRanges2 = result.customRanges) === null || _result$customRanges2 === void 0 ? void 0 : _result$customRanges2.find((range) => range.rangeId === toc.rangeId);
+	if (outer === null || outer === void 0 ? void 0 : outer.properties) outer.properties.cachedResult = getPlainText(result.dataStream.slice(1, -1)).replaceAll(FIELD_START, "").replaceAll(FIELD_END, "");
+	return result;
+}
+function resolvePageReferenceOffset(body, pageField) {
+	var _String$match, _pageField$properties, _body$customRanges6, _link$properties, _body$paragraphs;
+	const targetId = (_String$match = String(((_pageField$properties = pageField.properties) === null || _pageField$properties === void 0 ? void 0 : _pageField$properties.instruction) ?? "").match(/PAGEREF\s+"?([^"\s\\]+)"?/i)) === null || _String$match === void 0 ? void 0 : _String$match[1];
+	if (targetId) {
+		var _body$customRanges5;
+		const bookmark = (_body$customRanges5 = body.customRanges) === null || _body$customRanges5 === void 0 ? void 0 : _body$customRanges5.find((range) => {
+			var _range$properties4;
+			return range.rangeType === CustomRangeType.BOOKMARK && ((_range$properties4 = range.properties) === null || _range$properties4 === void 0 ? void 0 : _range$properties4.bookmarkId) === targetId;
+		});
+		if (bookmark) return bookmark.startIndex;
+	}
+	const link = (_body$customRanges6 = body.customRanges) === null || _body$customRanges6 === void 0 ? void 0 : _body$customRanges6.find((range) => range.rangeType === CustomRangeType.HYPERLINK && range.startIndex <= pageField.startIndex && pageField.endIndex <= range.endIndex);
+	const headingId = link === null || link === void 0 || (_link$properties = link.properties) === null || _link$properties === void 0 ? void 0 : _link$properties.headingId;
+	return (_body$paragraphs = body.paragraphs) === null || _body$paragraphs === void 0 || (_body$paragraphs = _body$paragraphs.find((paragraph) => {
+		var _paragraph$paragraphS;
+		return ((_paragraph$paragraphS = paragraph.paragraphStyle) === null || _paragraph$paragraphS === void 0 ? void 0 : _paragraph$paragraphS.headingId) === headingId;
+	})) === null || _body$paragraphs === void 0 ? void 0 : _body$paragraphs.startIndex;
+}
+function replaceFieldResult(body, field, value) {
+	var _body$paragraphs2, _body$customRanges7;
+	const start = field.startIndex + 1;
+	const end = field.endIndex;
+	if (field.properties) field.properties.cachedResult = value;
+	if (body.dataStream.slice(start, end) === value) return;
+	const delta = value.length - (end - start);
+	body.dataStream = `${body.dataStream.slice(0, start)}${value}${body.dataStream.slice(end)}`;
+	shiftRuns(body.textRuns, start, end, delta);
+	(_body$paragraphs2 = body.paragraphs) === null || _body$paragraphs2 === void 0 || _body$paragraphs2.forEach((paragraph) => {
+		if (paragraph.startIndex >= end) paragraph.startIndex += delta;
+	});
+	(_body$customRanges7 = body.customRanges) === null || _body$customRanges7 === void 0 || _body$customRanges7.forEach((range) => {
+		if (range.startIndex >= end) {
+			range.startIndex += delta;
+			range.endIndex += delta;
+		} else if (range.endIndex >= end) range.endIndex += delta;
+	});
+}
+function shiftRuns(runs, start, end, delta) {
+	runs === null || runs === void 0 || runs.forEach((run) => {
+		if (run.st >= end) {
+			run.st += delta;
+			run.ed += delta;
+		} else if (run.ed > start) run.ed += delta;
+	});
+}
+function buildTableOfContentsBody(body, toc, resolvePageNumber, idFactory = generateRandomId, options) {
+	var _toc$properties3, _toc$properties4, _toc$properties5, _toc$properties6, _toc$properties7, _toc$properties8, _body$customRanges8, _body$paragraphs3, _toc$properties9;
+	if (((_toc$properties3 = toc.properties) === null || _toc$properties3 === void 0 ? void 0 : _toc$properties3.locked) === BooleanNumber.TRUE) return null;
+	const instruction = String(((_toc$properties4 = toc.properties) === null || _toc$properties4 === void 0 ? void 0 : _toc$properties4.instruction) ?? "");
+	if (/\\c\s+/i.test(instruction)) return null;
+	const [minLevel, maxLevel] = parseOutlineLevelRange(instruction);
+	const headings = collectHeadings(body, toc, minLevel, maxLevel);
+	if (headings.length === 0) return null;
+	const showPageNumbers = ((_toc$properties5 = toc.properties) === null || _toc$properties5 === void 0 ? void 0 : _toc$properties5.showPageNumbers) !== false && !/\\n(?:\s|$)/i.test(instruction);
+	const rightAlignPageNumbers = showPageNumbers && ((_toc$properties6 = toc.properties) === null || _toc$properties6 === void 0 ? void 0 : _toc$properties6.rightAlignPageNumbers) !== false && !/\\p\s+/i.test(instruction);
+	const tabLeader = normalizeTabLeader((_toc$properties7 = toc.properties) === null || _toc$properties7 === void 0 ? void 0 : _toc$properties7.tabLeader);
+	const format = normalizeFormat((_toc$properties8 = toc.properties) === null || _toc$properties8 === void 0 ? void 0 : _toc$properties8.format);
+	const oldParagraphs = ((_body$customRanges8 = body.customRanges) === null || _body$customRanges8 === void 0 ? void 0 : _body$customRanges8.some((range) => range.rangeId === toc.rangeId)) ?? false ? ((_body$paragraphs3 = body.paragraphs) === null || _body$paragraphs3 === void 0 ? void 0 : _body$paragraphs3.filter((paragraph) => paragraph.startIndex >= toc.startIndex && paragraph.startIndex <= toc.endIndex)) ?? [] : [];
+	const title = typeof ((_toc$properties9 = toc.properties) === null || _toc$properties9 === void 0 ? void 0 : _toc$properties9.title) === "string" ? toc.properties.title.trim() : getExistingTableOfContentsTitle(body, oldParagraphs);
+	const result = {
+		dataStream: FIELD_START,
+		paragraphs: [],
+		customRanges: []
+	};
+	const ranges = result.customRanges;
+	const oldTitleParagraph = oldParagraphs.find((paragraph) => {
+		var _paragraph$styleId;
+		return ((_paragraph$styleId = paragraph.styleId) === null || _paragraph$styleId === void 0 ? void 0 : _paragraph$styleId.toLowerCase()) === "tocheading";
+	});
+	const oldEntryParagraphs = oldParagraphs.filter((paragraph) => paragraph !== oldTitleParagraph);
+	const usedParagraphIds = /* @__PURE__ */ new Set();
+	let cachedResult = "";
+	if (title) {
+		result.dataStream += `${title}\r`;
+		cachedResult += `${title}\r`;
+		result.paragraphs.push(cloneParagraphWithId({
+			startIndex: result.dataStream.length - 1,
+			paragraphId: (oldTitleParagraph === null || oldTitleParagraph === void 0 ? void 0 : oldTitleParagraph.paragraphId) ?? "",
+			styleId: "TOCHeading"
+		}, usedParagraphIds));
+	}
+	for (const [index, heading] of headings.entries()) {
+		const pageNumber = showPageNumbers ? resolvePageNumber(heading.startOffset) : void 0;
+		if (showPageNumbers && pageNumber == null) return null;
+		const entryStart = result.dataStream.length;
+		const separator = showPageNumbers ? rightAlignPageNumbers ? "	" : " " : "";
+		const visibleEntry = `${heading.text}${separator}${pageNumber ?? ""}`;
+		result.dataStream += `${heading.text}${separator}`;
+		const targetId = heading.bookmarkId ?? heading.headingId;
+		const link = {
+			startIndex: entryStart,
+			endIndex: result.dataStream.length - 1,
+			rangeId: idFactory(),
+			rangeType: CustomRangeType.HYPERLINK,
+			wholeEntity: false,
+			properties: {
+				...heading.bookmarkId ? { bookmarkId: targetId } : { headingId: targetId },
+				textStyleMode: "text"
+			}
+		};
+		ranges.push(link);
+		if (showPageNumbers) {
+			const pageFieldStart = result.dataStream.length;
+			result.dataStream += `${FIELD_START}${pageNumber}${FIELD_END}`;
+			const pageFieldEnd = result.dataStream.length - 1;
+			link.endIndex = pageFieldEnd;
+			ranges.push({
+				startIndex: pageFieldStart,
+				endIndex: pageFieldEnd,
+				rangeId: idFactory(),
+				rangeType: CustomRangeType.FIELD,
+				wholeEntity: false,
+				properties: {
+					fieldType: "PAGEREF",
+					instruction: `PAGEREF ${targetId} \\h`,
+					cachedResult: String(pageNumber),
+					sourceKind: "complex"
+				}
+			});
+		}
+		result.dataStream += "\r";
+		cachedResult += `${visibleEntry}\r`;
+		result.paragraphs.push(copyTocParagraph(oldEntryParagraphs, index, heading.level, result.dataStream.length - 1, usedParagraphIds, rightAlignPageNumbers ? options === null || options === void 0 ? void 0 : options.tabStopOffset : void 0, tabLeader, format));
+	}
+	result.dataStream += FIELD_END;
+	ranges.push({
+		startIndex: 0,
+		endIndex: result.dataStream.length - 1,
+		rangeId: toc.rangeId,
+		rangeType: CustomRangeType.FIELD,
+		wholeEntity: false,
+		properties: {
+			...Tools.deepClone(toc.properties ?? {}),
+			fieldType: "TOC",
+			instruction,
+			cachedResult
+		}
+	});
+	ranges.sort((left, right) => left.startIndex - right.startIndex || right.endIndex - left.endIndex);
+	return result;
+}
+function getExistingTableOfContentsTitle(body, paragraphs) {
+	const titleParagraph = paragraphs.find((paragraph) => {
+		var _paragraph$styleId2;
+		return ((_paragraph$styleId2 = paragraph.styleId) === null || _paragraph$styleId2 === void 0 ? void 0 : _paragraph$styleId2.toLowerCase()) === "tocheading";
+	});
+	if (!titleParagraph) return "";
+	const allParagraphs = [...body.paragraphs ?? []].sort((left, right) => left.startIndex - right.startIndex);
+	const index = allParagraphs.findIndex((paragraph) => paragraph === titleParagraph || paragraph.paragraphId === titleParagraph.paragraphId);
+	let start = index > 0 ? allParagraphs[index - 1].startIndex + 1 : 0;
+	while (body.dataStream[start] === FIELD_START || body.dataStream[start] === FIELD_END) start += 1;
+	return getPlainText(body.dataStream.slice(start, titleParagraph.startIndex)).trim();
+}
+function countTableOfContentsHeadings(body, levels = 3) {
+	if (!body) return 0;
+	return collectHeadings(body, void 0, 1, Math.min(9, Math.max(1, Math.trunc(levels)))).length;
+}
+function parseOutlineLevelRange(instruction) {
+	const match = instruction.match(/\\o\s+"(\d+)\s*-\s*(\d+)"/i);
+	const min = Math.max(1, Number((match === null || match === void 0 ? void 0 : match[1]) ?? 1));
+	return [min, Math.min(9, Math.max(min, Number((match === null || match === void 0 ? void 0 : match[2]) ?? 3)))];
+}
+function collectHeadings(body, toc, minLevel, maxLevel) {
+	const paragraphs = [...body.paragraphs ?? []].sort((left, right) => left.startIndex - right.startIndex);
+	let paragraphStart = 0;
+	return paragraphs.flatMap((paragraph) => {
+		var _paragraph$paragraphS2, _body$customRanges9, _bookmark$properties;
+		let startOffset = paragraphStart;
+		while (body.dataStream[startOffset] === FIELD_START || body.dataStream[startOffset] === FIELD_END) startOffset += 1;
+		paragraphStart = paragraph.startIndex + 1;
+		const level = getOutlineLevel(paragraph);
+		const headingId = (_paragraph$paragraphS2 = paragraph.paragraphStyle) === null || _paragraph$paragraphS2 === void 0 ? void 0 : _paragraph$paragraphS2.headingId;
+		if (!headingId || level == null || level < minLevel || level > maxLevel || toc && startOffset >= toc.startIndex && paragraph.startIndex <= toc.endIndex) return [];
+		const text = getPlainText(body.dataStream.slice(startOffset, paragraph.startIndex)).trim();
+		if (!text) return [];
+		const bookmark = (_body$customRanges9 = body.customRanges) === null || _body$customRanges9 === void 0 ? void 0 : _body$customRanges9.find((range) => {
+			var _range$properties5;
+			return range.rangeType === CustomRangeType.BOOKMARK && range.startIndex <= paragraph.startIndex && range.endIndex >= startOffset && ((_range$properties5 = range.properties) === null || _range$properties5 === void 0 ? void 0 : _range$properties5.bookmarkId);
+		});
+		return [{
+			bookmarkId: bookmark === null || bookmark === void 0 || (_bookmark$properties = bookmark.properties) === null || _bookmark$properties === void 0 ? void 0 : _bookmark$properties.bookmarkId,
+			headingId,
+			level,
+			paragraph,
+			startOffset,
+			text
+		}];
+	});
+}
+function getOutlineLevel(paragraph) {
+	var _paragraph$paragraphS3, _paragraph$paragraphS4;
+	const outlineLevel = (_paragraph$paragraphS3 = paragraph.paragraphStyle) === null || _paragraph$paragraphS3 === void 0 ? void 0 : _paragraph$paragraphS3.outlineLevel;
+	if (outlineLevel != null && outlineLevel >= 0 && outlineLevel <= 8) return outlineLevel + 1;
+	const namedStyle = (_paragraph$paragraphS4 = paragraph.paragraphStyle) === null || _paragraph$paragraphS4 === void 0 ? void 0 : _paragraph$paragraphS4.namedStyleType;
+	if (namedStyle != null && namedStyle >= NamedStyleType.HEADING_1 && namedStyle <= NamedStyleType.HEADING_5) return namedStyle - NamedStyleType.HEADING_1 + 1;
+}
+function copyTocParagraph(oldParagraphs, index, level, startIndex, usedParagraphIds, tabStopOffset, tabLeader = "dots", format = "fromTemplate") {
+	const source = oldParagraphs.find((paragraph) => {
+		var _paragraph$styleId3;
+		return ((_paragraph$styleId3 = paragraph.styleId) === null || _paragraph$styleId3 === void 0 || (_paragraph$styleId3 = _paragraph$styleId3.match(/TOC(\d+)/i)) === null || _paragraph$styleId3 === void 0 ? void 0 : _paragraph$styleId3[1]) === String(level);
+	}) ?? oldParagraphs[Math.min(index, oldParagraphs.length - 1)];
+	if (source) {
+		var _oldParagraphs$index;
+		return cloneParagraphWithId({
+			...source,
+			startIndex,
+			paragraphId: ((_oldParagraphs$index = oldParagraphs[index]) === null || _oldParagraphs$index === void 0 ? void 0 : _oldParagraphs$index.paragraphId) ?? ""
+		}, usedParagraphIds);
+	}
+	return {
+		startIndex,
+		paragraphId: createParagraphId(usedParagraphIds),
+		styleId: `TOC${level}`,
+		paragraphStyle: {
+			indentStart: { v: Math.max(0, level - 1) * getFormatIndent(format) },
+			spaceBelow: format === "modern" ? { v: 4 } : format === "classic" ? { v: 2 } : void 0,
+			tabStops: tabStopOffset == null ? void 0 : [{
+				offset: tabStopOffset,
+				alignment: TabStopAlignment.END,
+				leader: getTabStopLeader(tabLeader)
+			}]
+		}
+	};
+}
+function normalizeTabLeader(value) {
+	return value === "none" || value === "dashes" || value === "underline" ? value : "dots";
+}
+function getTabStopLeader(value) {
+	return {
+		none: TabStopLeader.NONE,
+		dots: TabStopLeader.DOT,
+		dashes: TabStopLeader.HYPHEN,
+		underline: TabStopLeader.UNDERSCORE
+	}[value];
+}
+function normalizeFormat(value) {
+	return value === "classic" || value === "modern" || value === "simple" ? value : "fromTemplate";
+}
+function getFormatIndent(format) {
+	return {
+		fromTemplate: 18,
+		classic: 14,
+		modern: 20,
+		simple: 12
+	}[format];
+}
+
+//#endregion
+//#region package.json
+var name = "@univerjs/docs-toc";
+var version = "1.0.0";
+
+//#endregion
+//#region src/config/config.ts
+/**
+* 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.
+*/
+const DOCS_TOC_PLUGIN_CONFIG_KEY = "docs-toc.config";
+const configSymbol = Symbol(DOCS_TOC_PLUGIN_CONFIG_KEY);
+const defaultPluginConfig = {};
+
+//#endregion
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateParam.js
+function __decorateParam(paramIndex, decorator) {
+	return function(target, key) {
+		decorator(target, key, paramIndex);
+	};
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/typeof.js
+function _typeof(o) {
+	"@babel/helpers - typeof";
+	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
+		return typeof o;
+	} : function(o) {
+		return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
+	}, _typeof(o);
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPrimitive.js
+function toPrimitive(t, r) {
+	if ("object" != _typeof(t) || !t) return t;
+	var e = t[Symbol.toPrimitive];
+	if (void 0 !== e) {
+		var i = e.call(t, r || "default");
+		if ("object" != _typeof(i)) return i;
+		throw new TypeError("@@toPrimitive must return a primitive value.");
+	}
+	return ("string" === r ? String : Number)(t);
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPropertyKey.js
+function toPropertyKey(t) {
+	var i = toPrimitive(t, "string");
+	return "symbol" == _typeof(i) ? i : i + "";
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/defineProperty.js
+function _defineProperty(e, r, t) {
+	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
+		value: t,
+		enumerable: !0,
+		configurable: !0,
+		writable: !0
+	}) : e[r] = t, e;
+}
+
+//#endregion
+//#region src/plugin.ts
+let UniverDocsTocPlugin = class UniverDocsTocPlugin extends Plugin {
+	constructor(_config = defaultPluginConfig, _injector, _configService, _commandService) {
+		super();
+		this._config = _config;
+		this._injector = _injector;
+		this._configService = _configService;
+		this._commandService = _commandService;
+		const { ...rest } = merge({}, defaultPluginConfig, this._config);
+		this._configService.setConfig(DOCS_TOC_PLUGIN_CONFIG_KEY, rest);
+	}
+	onStarting() {
+		[
+			InsertTableOfContentsCommand,
+			UpdateTableOfContentsCommand,
+			DeleteTableOfContentsCommand
+		].forEach((command) => this.disposeWithMe(this._commandService.registerCommand(command)));
+	}
+};
+_defineProperty(UniverDocsTocPlugin, "pluginName", "DOCS_TOC_PLUGIN");
+_defineProperty(UniverDocsTocPlugin, "packageName", name);
+_defineProperty(UniverDocsTocPlugin, "version", version);
+_defineProperty(UniverDocsTocPlugin, "type", UniverInstanceType.UNIVER_DOC);
+UniverDocsTocPlugin = __decorate([
+	DependentOn(UniverDocsPlugin, UniverRenderEnginePlugin),
+	__decorateParam(1, Inject(Injector)),
+	__decorateParam(2, IConfigService),
+	__decorateParam(3, ICommandService)
+], UniverDocsTocPlugin);
+
+//#endregion
+export { DeleteTableOfContentsCommand, InsertTableOfContentsCommand, UniverDocsTocPlugin, UpdateTableOfContentsCommand, buildPageNumberOnlyTableOfContentsBody, buildTableOfContentsBody, buildTableOfContentsInstruction, countTableOfContentsHeadings, findTableOfContentsAtOffset };

package/lib/types/commands/table-of-contents.command.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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, ICustomRange, IDocumentBody } from '@univerjs/core';
+export interface IUpdateTableOfContentsCommandParams {
+    unitId?: string;
+    rangeId?: string;
+    mode?: 'pageNumbersOnly' | 'entireTable';
+}
+export interface IInsertTableOfContentsCommandParams {
+    unitId?: string;
+    levels?: number;
+    showPageNumbers?: boolean;
+    rightAlignPageNumbers?: boolean;
+    tabLeader?: TableOfContentsTabLeader;
+    format?: TableOfContentsFormat;
+    title?: string;
+}
+export type TableOfContentsTabLeader = 'none' | 'dots' | 'dashes' | 'underline';
+export type TableOfContentsFormat = 'fromTemplate' | 'classic' | 'modern' | 'simple';
+export interface IDeleteTableOfContentsCommandParams {
+    unitId?: string;
+    rangeId?: string;
+}
+export declare const UpdateTableOfContentsCommand: ICommand<IUpdateTableOfContentsCommandParams>;
+export declare const DeleteTableOfContentsCommand: ICommand<IDeleteTableOfContentsCommandParams>;
+export declare const InsertTableOfContentsCommand: ICommand<IInsertTableOfContentsCommandParams>;
+export declare function buildTableOfContentsInstruction(options?: Pick<IInsertTableOfContentsCommandParams, 'levels' | 'showPageNumbers' | 'rightAlignPageNumbers'>): string;
+export declare function findTableOfContentsAtOffset(body: IDocumentBody | null | undefined, offset: number | undefined): ICustomRange | undefined;
+export declare function buildPageNumberOnlyTableOfContentsBody(body: IDocumentBody, toc: ICustomRange, resolvePageNumber: (offset: number) => number | undefined): IDocumentBody | null;
+export declare function buildTableOfContentsBody(body: IDocumentBody, toc: ICustomRange, resolvePageNumber: (offset: number) => number | undefined, idFactory?: () => string, options?: {
+    tabStopOffset?: number;
+}): IDocumentBody | null;
+export declare function countTableOfContentsHeadings(body: IDocumentBody | null | undefined, levels?: number): number;

package/lib/types/config/config.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.
+ */
+export declare const DOCS_TOC_PLUGIN_CONFIG_KEY = "docs-toc.config";
+export declare const configSymbol: unique symbol;
+export interface IUniverDocsTocConfig {
+}
+export declare const defaultPluginConfig: IUniverDocsTocConfig;