@univerjs/docs 1.0.0-alpha.8 → 1.0.0-beta.1

package/lib/facade.js

@@ -1,6 +1,6 @@
 import { BooleanNumber, ColumnSeparatorType, DashStyleType, DataStreamTreeTokenType, DocumentFlavor, ICommandService, IResourceLoaderService, IUniverInstanceService, Inject, Injector, JSONX, PageOrientType, PresetListType, RESTORE_INSERTED_PARAGRAPH_IDS, RedoCommand, SectionType, TextX, TextXActionType, Tools, UndoCommand, UniverInstanceType, UpdateDocsAttributeType, createParagraphId, createSectionId, generateRandomId, getParagraphContentStartOffset, getRichTextEditPath, getSectionHeaderFooterReferenceKey, regexp, resolveSectionHeaderFooterReference } from "@univerjs/core";
 import { FBaseInitialable, FEnum, FUniver } from "@univerjs/core/facade";
-import { CreateHeaderFooterCommand, DeleteDocumentSectionBreakCommand, HeaderFooterType, InsertDocumentColumnBreakCommand, InsertDocumentSectionBreakCommand, RichTextEditingMutation, SetSectionHeaderFooterLinkCommand, UpdateDocumentParagraphStyleCommand, UpdateDocumentSectionCommand, createSectionColumnProperties, generateParagraphs, getEffectiveSectionPageSetup, getSectionContentWidth, getTopLevelSectionBreaks } from "@univerjs/docs";
+import { CreateHeaderFooterCommand, DeleteDocumentSectionBreakCommand, HeaderFooterType, InsertDocumentColumnBreakCommand, InsertDocumentSectionBreakCommand, RichTextEditingMutation, SetDocumentNameCommand, SetSectionHeaderFooterLinkCommand, UpdateDocumentParagraphStyleCommand, UpdateDocumentSectionCommand, createSectionColumnProperties, generateParagraphs, getEffectiveSectionPageSetup, getSectionContentWidth, getTopLevelSectionBreaks } from "@univerjs/docs";
 
 //#region src/facade/utils.ts
 function cloneParagraphStyle(paragraphStyle) {
@@ -156,14 +156,11 @@ var FDocumentTextRange = class extends FBaseInitialable {
 	*/
 	getExplicitTextStyleRuns() {
 		const { textRuns = [] } = this._document.getBody(this._segmentId);
-		return textRuns.filter((run) => run.st < this._endOffset && run.ed > this._startOffset).map((run) => {
-			var _run$ts;
-			return {
-				startOffset: Math.max(run.st, this._startOffset),
-				endOffset: Math.min(run.ed, this._endOffset),
-				textStyle: Tools.deepClone((_run$ts = run.ts) !== null && _run$ts !== void 0 ? _run$ts : {})
-			};
-		});
+		return textRuns.filter((run) => run.st < this._endOffset && run.ed > this._startOffset).map((run) => ({
+			startOffset: Math.max(run.st, this._startOffset),
+			endOffset: Math.min(run.ed, this._endOffset),
+			textStyle: Tools.deepClone(run.ts ?? {})
+		}));
 	}
 	/**
 	* Returns top-level style properties that have the same explicit value
@@ -407,10 +404,9 @@ let FDocumentParagraph = class FDocumentParagraph extends FBaseInitialable {
 	* ```
 	*/
 	findText(text, options = {}) {
-		var _options$occurrence, _this$findAllText$occ;
-		const occurrence = (_options$occurrence = options.occurrence) !== null && _options$occurrence !== void 0 ? _options$occurrence : 0;
+		const occurrence = options.occurrence ?? 0;
 		if (!Number.isInteger(occurrence) || occurrence < 0) throw new RangeError("Text occurrence must be a non-negative integer.");
-		return (_this$findAllText$occ = this.findAllText(text, options)[occurrence]) !== null && _this$findAllText$occ !== void 0 ? _this$findAllText$occ : null;
+		return this.findAllText(text, options)[occurrence] ?? null;
 	}
 	/**
 	* Finds every non-overlapping literal text occurrence inside this paragraph.
@@ -436,9 +432,8 @@ let FDocumentParagraph = class FDocumentParagraph extends FBaseInitialable {
 	* ```
 	*/
 	findAllText(text, options = {}) {
-		var _options$matchCase;
 		if (text.length === 0) throw new TypeError("Text to find must not be empty.");
-		const matchCase = (_options$matchCase = options.matchCase) !== null && _options$matchCase !== void 0 ? _options$matchCase : true;
+		const matchCase = options.matchCase ?? true;
 		const paragraphText = this.getText();
 		const matcher = regexp.createLiteralRegExp(text, matchCase ? "gu" : "giu");
 		const { startOffset } = this.getInfo();
@@ -738,8 +733,7 @@ let FDocumentSection = class FDocumentSection {
 	* ```
 	*/
 	getColumns() {
-		var _this$_getConfigSnaps;
-		return Tools.deepClone((_this$_getConfigSnaps = this._getConfigSnapshot().columnProperties) !== null && _this$_getConfigSnaps !== void 0 ? _this$_getConfigSnaps : []);
+		return Tools.deepClone(this._getConfigSnapshot().columnProperties ?? []);
 	}
 	/**
 	* Returns a compact serializable section summary.
@@ -750,10 +744,9 @@ let FDocumentSection = class FDocumentSection {
 	* ```
 	*/
 	describe() {
-		var _config$columnPropert, _config$columnSeparat, _config$sectionType;
 		const { index } = this._resolve();
 		const config = this._getConfigSnapshot();
-		const columns = (_config$columnPropert = config.columnProperties) !== null && _config$columnPropert !== void 0 ? _config$columnPropert : [];
+		const columns = config.columnProperties ?? [];
 		const headerFooter = {
 			defaultHeader: this._describeHeaderFooterReference("header", "default"),
 			defaultFooter: this._describeHeaderFooterReference("footer", "default"),
@@ -768,8 +761,8 @@ let FDocumentSection = class FDocumentSection {
 			range: this._getRange(index),
 			columnCount: columns.length || 1,
 			columns: Tools.deepClone(columns),
-			columnSeparatorType: (_config$columnSeparat = config.columnSeparatorType) !== null && _config$columnSeparat !== void 0 ? _config$columnSeparat : ColumnSeparatorType.NONE,
-			sectionType: (_config$sectionType = config.sectionType) !== null && _config$sectionType !== void 0 ? _config$sectionType : SectionType.SECTION_TYPE_UNSPECIFIED,
+			columnSeparatorType: config.columnSeparatorType ?? ColumnSeparatorType.NONE,
+			sectionType: config.sectionType ?? SectionType.SECTION_TYPE_UNSPECIFIED,
 			headerFooter,
 			config
 		};
@@ -787,15 +780,14 @@ let FDocumentSection = class FDocumentSection {
 	* ```
 	*/
 	setColumns(columnCount, options = {}) {
-		var _options$gap, _options$separator;
 		this._assertTraditionalDocument();
 		if (!Number.isInteger(columnCount) || columnCount < 1) throw new RangeError("Section column count must be a positive integer.");
 		if (options.widths && options.widths.length !== columnCount) throw new RangeError("Section column widths must match the column count.");
 		if (options.gap != null && (!Number.isFinite(options.gap) || options.gap < 0)) throw new RangeError("Section column gap must be finite and non-negative.");
-		const gap = Math.max(0, (_options$gap = options.gap) !== null && _options$gap !== void 0 ? _options$gap : 18);
+		const gap = Math.max(0, options.gap ?? 18);
 		const config = this._getConfigSnapshot();
 		const columns = createSectionColumnProperties(this._document.getDocumentDataModel().getSnapshot().documentStyle, config, columnCount, gap, options.widths);
-		const separator = typeof options.separator === "boolean" ? options.separator ? ColumnSeparatorType.BETWEEN_EACH_COLUMN : ColumnSeparatorType.NONE : (_options$separator = options.separator) !== null && _options$separator !== void 0 ? _options$separator : ColumnSeparatorType.NONE;
+		const separator = typeof options.separator === "boolean" ? options.separator ? ColumnSeparatorType.BETWEEN_EACH_COLUMN : ColumnSeparatorType.NONE : options.separator ?? ColumnSeparatorType.NONE;
 		if (!Object.values(ColumnSeparatorType).includes(separator)) throw new RangeError("Invalid section column separator type.");
 		return this._update({
 			columnProperties: columns,
@@ -1009,8 +1001,7 @@ let FDocumentSection = class FDocumentSection {
 	* ```
 	*/
 	getHeaderId(variant = "default") {
-		var _this$_getHeaderFoote;
-		return (_this$_getHeaderFoote = this._getHeaderFooterReference("header", variant).segmentId) !== null && _this$_getHeaderFoote !== void 0 ? _this$_getHeaderFoote : null;
+		return this._getHeaderFooterReference("header", variant).segmentId ?? null;
 	}
 	/**
 	* Returns the effective footer id after resolving links to previous sections.
@@ -1021,8 +1012,7 @@ let FDocumentSection = class FDocumentSection {
 	* ```
 	*/
 	getFooterId(variant = "default") {
-		var _this$_getHeaderFoote2;
-		return (_this$_getHeaderFoote2 = this._getHeaderFooterReference("footer", variant).segmentId) !== null && _this$_getHeaderFoote2 !== void 0 ? _this$_getHeaderFoote2 : null;
+		return this._getHeaderFooterReference("footer", variant).segmentId ?? null;
 	}
 	/**
 	* Whether this header variant inherits the previous section's reference.
@@ -1157,10 +1147,9 @@ let FDocumentSection = class FDocumentSection {
 		return resolveSectionHeaderFooterReference(this._document.getDocumentDataModel().getSnapshot().documentStyle, getTopLevelSectionBreaks(this._document.getBody()), index, getSectionHeaderFooterReferenceKey(kind, variant));
 	}
 	_describeHeaderFooterReference(kind, variant) {
-		var _reference$segmentId;
 		const reference = this._getHeaderFooterReference(kind, variant);
 		return {
-			segmentId: (_reference$segmentId = reference.segmentId) !== null && _reference$segmentId !== void 0 ? _reference$segmentId : null,
+			segmentId: reference.segmentId ?? null,
 			linkedToPrevious: reference.linkedToPrevious
 		};
 	}
@@ -1276,6 +1265,28 @@ let FDocument = class FDocument extends FBaseInitialable {
 		return documentDataModel;
 	}
 	/**
+	* Returns the document's custom blocks in stable model order.
+	*
+	* This method is available in Node/headless environments and does not
+	* perform font measurement, line wrapping, pagination, or rendering.
+	*
+	* @returns {IDocumentCustomBlockLayout} Custom block identifiers and model positions.
+	* @example
+	* ```ts
+	* const document = univerAPI.getActiveDocument();
+	* const layout = document?.getCustomBlockLayout();
+	* console.log(layout?.blocks);
+	* ```
+	*/
+	getCustomBlockLayout() {
+		var _this$_documentDataMo;
+		return { blocks: (((_this$_documentDataMo = this._documentDataModel.getBody()) === null || _this$_documentDataMo === void 0 ? void 0 : _this$_documentDataMo.customBlocks) ?? []).map(({ blockId, startIndex }, index) => ({
+			blockId,
+			startIndex,
+			index
+		})) };
+	}
+	/**
 	* Get the document body or header/footer body by the segment id.
 	* The main body has an empty segment id.
 	* The header and footer body have their respective segment ids.
@@ -1291,8 +1302,8 @@ let FDocument = class FDocument extends FBaseInitialable {
 	* ```
 	*/
 	getBody(segmentId = "") {
-		var _this$_documentDataMo;
-		const body = (_this$_documentDataMo = this._documentDataModel.getSelfOrHeaderFooterModel(segmentId)) === null || _this$_documentDataMo === void 0 ? void 0 : _this$_documentDataMo.getBody();
+		var _this$_documentDataMo2;
+		const body = (_this$_documentDataMo2 = this._documentDataModel.getSelfOrHeaderFooterModel(segmentId)) === null || _this$_documentDataMo2 === void 0 ? void 0 : _this$_documentDataMo2.getBody();
 		if (!body) throw new Error(segmentId === "" ? "Body is not found in the document." : `Body is not found in the segment: ${segmentId}`);
 		return body;
 	}
@@ -1324,6 +1335,24 @@ let FDocument = class FDocument extends FBaseInitialable {
 		return this._documentDataModel.getTitle() || "";
 	}
 	/**
+	* Set the document name.
+	* @param {string} name The new document name.
+	* @returns {FDocument} The current document for chaining.
+	*
+	* @example
+	* ```ts
+	* const document = univerAPI.getActiveDocument();
+	* document?.setName('Quarterly Report');
+	* ```
+	*/
+	setName(name) {
+		this._commandService.syncExecuteCommand(SetDocumentNameCommand.id, {
+			unitId: this.id,
+			name
+		});
+		return this;
+	}
+	/**
 	* Returns the document's explicit layout flavor.
 	*
 	* Use this method when all three states matter. Do not infer a Traditional
@@ -1389,8 +1418,7 @@ let FDocument = class FDocument extends FBaseInitialable {
 		return this._resolveDocumentFlavor() === DocumentFlavor.MODERN;
 	}
 	_resolveDocumentFlavor() {
-		var _this$_documentDataMo2;
-		return (_this$_documentDataMo2 = this._documentDataModel.getSnapshot().documentStyle.documentFlavor) !== null && _this$_documentDataMo2 !== void 0 ? _this$_documentDataMo2 : DocumentFlavor.UNSPECIFIED;
+		return this._documentDataModel.getSnapshot().documentStyle.documentFlavor ?? DocumentFlavor.UNSPECIFIED;
 	}
 	/**
 	* Save the document snapshot data, including the document content and resource data, etc.
@@ -1565,8 +1593,7 @@ let FDocument = class FDocument extends FBaseInitialable {
 	* ```
 	*/
 	getSection(index) {
-		var _this$getSections$ind;
-		return (_this$getSections$ind = this.getSections()[index]) !== null && _this$getSections$ind !== void 0 ? _this$getSections$ind : null;
+		return this.getSections()[index] ?? null;
 	}
 	/**
 	* Returns the traditional section containing a data-stream offset, or `null` in modern documents.
@@ -1580,11 +1607,10 @@ let FDocument = class FDocument extends FBaseInitialable {
 	* ```
 	*/
 	getSectionAt(offset) {
-		var _this$getSections$fin;
-		return (_this$getSections$fin = this.getSections().find((section) => {
+		return this.getSections().find((section) => {
 			const range = section.getRange();
 			return offset >= range.startOffset && offset < range.endOffset;
-		})) !== null && _this$getSections$fin !== void 0 ? _this$getSections$fin : null;
+		}) ?? null;
 	}
 	/**
 	* Inserts a traditional document section break and returns its stable facade.
@@ -1639,10 +1665,9 @@ let FDocument = class FDocument extends FBaseInitialable {
 	* ```
 	*/
 	insertSectionBreak(offset, options = {}) {
-		var _this$getBody$section;
 		if (this._documentDataModel.getSnapshot().documentStyle.documentFlavor !== DocumentFlavor.TRADITIONAL) throw new DocsSectionUnsupportedDocumentFlavorError();
 		const { nextSectionType, ...config } = options;
-		const sectionId = createSectionId(new Set(((_this$getBody$section = this.getBody().sectionBreaks) !== null && _this$getBody$section !== void 0 ? _this$getBody$section : []).map((section) => section.sectionId)));
+		const sectionId = createSectionId(new Set((this.getBody().sectionBreaks ?? []).map((section) => section.sectionId)));
 		return this._commandService.syncExecuteCommand(InsertDocumentSectionBreakCommand.id, {
 			unitId: this.getId(),
 			offset,
@@ -1896,36 +1921,29 @@ let FDocument = class FDocument extends FBaseInitialable {
 		return segmentId;
 	}
 	_getHeaderFooterCreateInfo(kind, pageIndex) {
-		var _documentStyle$defaul, _documentStyle$defaul2;
 		const { documentStyle } = this._documentDataModel.getSnapshot();
 		const isFirstPage = pageIndex === 0;
 		const isEvenPage = (pageIndex + 1) % 2 === 0;
-		if (isFirstPage && documentStyle.useFirstPageHeaderFooter === BooleanNumber.TRUE) {
-			var _documentStyle$firstP, _documentStyle$firstP2;
-			return kind === "header" ? {
-				createType: HeaderFooterType.FIRST_PAGE_HEADER,
-				segmentId: (_documentStyle$firstP = documentStyle.firstPageHeaderId) !== null && _documentStyle$firstP !== void 0 ? _documentStyle$firstP : ""
-			} : {
-				createType: HeaderFooterType.FIRST_PAGE_FOOTER,
-				segmentId: (_documentStyle$firstP2 = documentStyle.firstPageFooterId) !== null && _documentStyle$firstP2 !== void 0 ? _documentStyle$firstP2 : ""
-			};
-		}
-		if (isEvenPage && documentStyle.evenAndOddHeaders === BooleanNumber.TRUE) {
-			var _documentStyle$evenPa, _documentStyle$evenPa2;
-			return kind === "header" ? {
-				createType: HeaderFooterType.EVEN_PAGE_HEADER,
-				segmentId: (_documentStyle$evenPa = documentStyle.evenPageHeaderId) !== null && _documentStyle$evenPa !== void 0 ? _documentStyle$evenPa : ""
-			} : {
-				createType: HeaderFooterType.EVEN_PAGE_FOOTER,
-				segmentId: (_documentStyle$evenPa2 = documentStyle.evenPageFooterId) !== null && _documentStyle$evenPa2 !== void 0 ? _documentStyle$evenPa2 : ""
-			};
-		}
+		if (isFirstPage && documentStyle.useFirstPageHeaderFooter === BooleanNumber.TRUE) return kind === "header" ? {
+			createType: HeaderFooterType.FIRST_PAGE_HEADER,
+			segmentId: documentStyle.firstPageHeaderId ?? ""
+		} : {
+			createType: HeaderFooterType.FIRST_PAGE_FOOTER,
+			segmentId: documentStyle.firstPageFooterId ?? ""
+		};
+		if (isEvenPage && documentStyle.evenAndOddHeaders === BooleanNumber.TRUE) return kind === "header" ? {
+			createType: HeaderFooterType.EVEN_PAGE_HEADER,
+			segmentId: documentStyle.evenPageHeaderId ?? ""
+		} : {
+			createType: HeaderFooterType.EVEN_PAGE_FOOTER,
+			segmentId: documentStyle.evenPageFooterId ?? ""
+		};
 		return kind === "header" ? {
 			createType: HeaderFooterType.DEFAULT_HEADER,
-			segmentId: (_documentStyle$defaul = documentStyle.defaultHeaderId) !== null && _documentStyle$defaul !== void 0 ? _documentStyle$defaul : ""
+			segmentId: documentStyle.defaultHeaderId ?? ""
 		} : {
 			createType: HeaderFooterType.DEFAULT_FOOTER,
-			segmentId: (_documentStyle$defaul2 = documentStyle.defaultFooterId) !== null && _documentStyle$defaul2 !== void 0 ? _documentStyle$defaul2 : ""
+			segmentId: documentStyle.defaultFooterId ?? ""
 		};
 	}
 };