@univerjs/docs 1.0.0-alpha.1 → 1.0.0-alpha.3

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

@@ -13,10 +13,19 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { DocumentDataModel, IDocumentData } from '@univerjs/core';
+import type { DocumentDataModel, IDocumentBody, IDocumentData, IParagraphBorder, ISectionBreak } from '@univerjs/core';
+import type { IHeaderFooterProps } from '@univerjs/docs';
+import type { IFDocumentTextRange } from './utils';
 import { ICommandService, Injector, IResourceLoaderService, IUniverInstanceService } from '@univerjs/core';
 import { FBaseInitialable } from '@univerjs/core/facade';
-import { FDocumentBody } from './f-document-body';
+import { FDocumentParagraph } from './f-document-paragraph';
+import { FDocumentSection } from './f-document-section';
+import { FDocumentTextRange } from './f-document-text-range';
+export interface IFDocumentParagraphQuery {
+    text?: string;
+    paragraphId?: string;
+    segmentId?: string;
+}
 /**
  * Facade API object bounded to a document. It provides a set of methods to interact with the document.
  * @hideconstructor
@@ -31,39 +40,34 @@ export declare class FDocument extends FBaseInitialable {
     constructor(_documentDataModel: DocumentDataModel, _injector: Injector, _univerInstanceService: IUniverInstanceService, _resourceLoaderService: IResourceLoaderService, _commandService: ICommandService);
     /**
      * Get the document data model of the document.
+     * @param {string} segmentId The segment id used to get the header/footer data model. Defaults to an empty string for the document data model of the document.
      * @returns {DocumentDataModel} The document data model.
      * @example
      * ```typescript
      * const fDocument = univerAPI.getActiveDocument();
-     * const documentDataModel = fDocument.getDocumentDataModel();
-     * console.log(documentDataModel);
+     * console.log(fDocument.getDocumentDataModel());
+     *
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * console.log(fDocument.getDocumentDataModel(headerSegmentId));
      * ```
      */
-    getDocumentDataModel(): DocumentDataModel;
+    getDocumentDataModel(segmentId?: string): DocumentDataModel;
     /**
-     * Get the document body facade.
-     *
-     * The returned body facade provides synchronous Google Docs-like element APIs
-     * for reading and editing top-level document body elements. Paragraph elements
-     * use their persisted `paragraphId` values. Persisted elements, such as tables
-     * and custom blocks, use their existing ids.
-     *
-     * @returns {FDocumentBody} The document body API instance.
+     * 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.
+     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @returns {IDocumentBody} The document body.
      * @example
      * ```typescript
      * const fDocument = univerAPI.getActiveDocument();
-     * const fDocumentBody = fDocument.getBody();
-     * console.log(fDocumentBody.getBody());
+     * console.log(fDocument.getBody()); // Get the main body
      *
-     * const element = fDocumentBody.getElement(0);
-     * if (element.isParagraph()) {
-     *   const paragraph = element.asParagraph();
-     *   paragraph.appendText(' updated');
-     *   console.log(paragraph.getText());
-     * }
+     * const footerSegmentId = fDocument.ensurePageFooter();
+     * console.log(fDocument.getBody(footerSegmentId)); // Get the footer body
      * ```
      */
-    getBody(): FDocumentBody;
+    getBody(segmentId?: string): IDocumentBody;
     dispose(): void;
     /**
      * Get the document id.
@@ -71,8 +75,7 @@ export declare class FDocument extends FBaseInitialable {
      * @example
      * ```typescript
      * const fDocument = univerAPI.getActiveDocument();
-     * const unitId = fDocument.getId();
-     * console.log(unitId);
+     * console.log(fDocument.getId());
      * ```
      */
     getId(): string;
@@ -82,11 +85,20 @@ export declare class FDocument extends FBaseInitialable {
      * @example
      * ```typescript
      * const fDocument = univerAPI.getActiveDocument();
-     * const name = fDocument.getName();
-     * console.log(name);
+     * console.log(fDocument.getName());
      * ```
      */
     getName(): string;
+    /**
+     * Whether the document is a modern document or not.
+     * @returns {boolean} `true` if the document is a modern document, or `false` if it is not.
+     * @example
+     * ```typescript
+     * const fDocument = univerAPI.getActiveDocument();
+     * console.log(fDocument.isModern());
+     * ```
+     */
+    isModern(): boolean;
     /**
      * Save the document snapshot data, including the document content and resource data, etc.
      * @returns {IDocumentData} The document snapshot data.
@@ -120,4 +132,282 @@ export declare class FDocument extends FBaseInitialable {
      * ```
      */
     redo(): boolean;
+    /**
+     * Ensure the page header segment exists and return its segment id.
+     * @param {number} pageIndex The zero-based page index. Defaults to the first page.
+     * @returns {string} The header segment id.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * fDocument.insertText(0, 'Header text', headerSegmentId);
+     * ```
+     */
+    ensurePageHeader(pageIndex?: number): string;
+    /**
+     * Ensure the page footer segment exists and return its segment id.
+     * @param {number} pageIndex The zero-based page index. Defaults to the first page.
+     * @returns {string} The footer segment id.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const footerSegmentId = fDocument.ensurePageFooter();
+     * fDocument.insertText(0, 'Footer text', footerSegmentId);
+     * ```
+     */
+    ensurePageFooter(pageIndex?: number): string;
+    /**
+     * Insert plain text at a document body offset.
+     * @param {number} index The zero-based insertion offset.
+     * @param {string} text The plain text to insert.
+     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @returns {boolean} `true` if the edit was applied.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * fDocument.insertText(0, 'Hello ');
+     *
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * fDocument.insertText(0, 'Header text', headerSegmentId);
+     * ```
+     */
+    insertText(index: number, text: string, segmentId?: string): boolean;
+    /**
+     * Returns document-level header/footer switches and margins. Margin values are in points (pt).
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * console.log(fDocument?.getHeaderFooterOptions());
+     * ```
+     */
+    getHeaderFooterOptions(): IHeaderFooterProps;
+    /**
+     * Updates document-level header/footer switches and margins in a traditional document.
+     * `marginHeader` and `marginFooter` are in points (pt).
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * if (fDocument && !fDocument.isModern()) {
+     *   fDocument.setHeaderFooterOptions({ marginHeader: 36, marginFooter: 36 });
+     * }
+     * ```
+     */
+    setHeaderFooterOptions(options: IHeaderFooterProps): boolean;
+    /**
+     * Creates a facade for reading and styling a document text range.
+     * The end offset is exclusive, and offsets are scoped to the selected body segment.
+     * @param {number} startOffset The inclusive start offset.
+     * @param {number} endOffset The exclusive end offset.
+     * @param {string} segmentId The header/footer segment id, or an empty string for the main body.
+     * @returns {FDocumentTextRange} A fixed text-range facade.
+     * @example
+     * ```ts
+     * const range = univerAPI.getActiveDocument()?.getTextRange(0, 5);
+     * console.log(range?.describe());
+     * range?.setTextStyle({ bl: 1 });
+     * ```
+     */
+    getTextRange(startOffset: number, endOffset: number, segmentId?: string): FDocumentTextRange;
+    /**
+     * Returns traditional document sections backed by persisted SectionBreak ids.
+     * Modern documents use ColumnGroup instead and return an empty array from this read API.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const sections = fDocument?.getSections() ?? [];
+     * console.log(sections.map((section) => section.describe()));
+     * ```
+     */
+    getSections(): FDocumentSection[];
+    /**
+     * Returns a traditional section by zero-based index, or `null` in modern documents.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const firstSection = fDocument?.getSection(0);
+     * console.log(firstSection?.describe());
+     * ```
+     */
+    getSection(index: number): FDocumentSection | null;
+    /**
+     * Returns the traditional section containing a data-stream offset, or `null` in modern documents.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument?.findParagraphByText('Launch');
+     * const offset = paragraph?.getInfo().startOffset;
+     * const section = offset == null ? null : fDocument?.getSectionAt(offset);
+     * console.log(section?.getId());
+     * ```
+     */
+    getSectionAt(offset: number): FDocumentSection | null;
+    /**
+     * Inserts a traditional document section break and returns its stable facade.
+     * Modern documents must use ColumnGroup and throw `DocsSectionUnsupportedDocumentFlavorError`.
+     * Numeric layout values in `config` are in points (pt).
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * if (fDocument && !fDocument.isModern()) {
+     *   const paragraph = fDocument.findParagraphByText('Appendix');
+     *   const offset = paragraph?.getInfo().startOffset;
+     *   const section = offset == null ? null : fDocument.insertSectionBreak(offset);
+     *   console.log(section?.getId());
+     * }
+     * ```
+     */
+    insertSectionBreak(offset: number, config?: Partial<Omit<ISectionBreak, 'sectionId' | 'startIndex'>>): FDocumentSection | null;
+    /**
+     * Inserts a column-break token in a traditional document.
+     * Modern documents must use ColumnGroup and throw `DocsSectionUnsupportedDocumentFlavorError`.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * if (fDocument && !fDocument.isModern()) {
+     *   const paragraph = fDocument.findParagraphByText('Continue in next column');
+     *   const offset = paragraph?.getInfo().startOffset;
+     *   if (offset != null) {
+     *     fDocument.insertColumnBreak(offset);
+     *   }
+     * }
+     * ```
+     */
+    insertColumnBreak(offset: number): boolean;
+    /**
+     * Inserts a horizontal rule using the existing paragraph `borderBottom` mechanism.
+     * The returned paragraph can be inspected or removed with normal paragraph APIs.
+     * Border width and padding are in points (pt).
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument?.findParagraphByText('Summary');
+     * const offset = paragraph?.getInfo().startOffset;
+     * const rule = offset == null ? null : fDocument?.insertHorizontalRule(offset);
+     * console.log(rule?.getId());
+     * ```
+     */
+    insertHorizontalRule(offset: number, border?: IParagraphBorder, segmentId?: string): FDocumentParagraph | null;
+    /**
+     * Get all paragraphs in the document body or header/footer body by the segment id.
+     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @returns {FDocumentParagraph[]} An array of paragraph facade instances.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraphs = fDocument.getParagraphs();
+     * console.log(paragraphs);
+     *
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * const headerParagraphs = fDocument.getParagraphs(headerSegmentId);
+     * console.log(headerParagraphs);
+     * ```
+     */
+    getParagraphs(segmentId?: string): FDocumentParagraph[];
+    /**
+     * Get a paragraph by its paragraph id and segment id.
+     * @param {string} paragraphId The paragraph id.
+     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @returns {FDocumentParagraph | null} The paragraph facade instance, or `null` if the paragraph is not found.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.getParagraph('paragraph-01');
+     * console.log(paragraph);
+     *
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * const headerParagraph = fDocument.getParagraph('header-paragraph-01', headerSegmentId);
+     * console.log(headerParagraph);
+     * ```
+     */
+    getParagraph(paragraphId: string, segmentId?: string): FDocumentParagraph | null;
+    /**
+     * Find a paragraph by its text content and segment id.
+     * @param {string} text The text content to search for.
+     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @returns {FDocumentParagraph | null} The paragraph facade instance, or `null` if the paragraph is not found.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.findParagraphByText('Hello');
+     * console.log(paragraph);
+     *
+     * const footerSegmentId = fDocument.ensurePageFooter();
+     * const footerParagraph = fDocument.findParagraphByText('Page', footerSegmentId);
+     * console.log(footerParagraph);
+     * ```
+     */
+    findParagraphByText(text: string, segmentId?: string): FDocumentParagraph | null;
+    /**
+     * Find paragraphs by a query object, which can include text content, paragraph id, and segment id.
+     * @param {string | IFDocumentParagraphQuery} query The query object or text content to search for.
+     * @returns {FDocumentParagraph[]} An array of paragraph facade instances that match the query.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraphsWithText = fDocument.findParagraphs('Hello');
+     * console.log(paragraphsWithText);
+     *
+     * const paragraphsWithId = fDocument.findParagraphs({ paragraphId: 'paragraph-01' });
+     * console.log(paragraphsWithId);
+     *
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * const paragraphsWithSegment = fDocument.findParagraphs({ segmentId: headerSegmentId });
+     * console.log(paragraphsWithSegment);
+     * ```
+     */
+    findParagraphs(query: string | IFDocumentParagraphQuery): FDocumentParagraph[];
+    /**
+     * Insert a plain-text paragraph before the paragraph at the given paragraph index.
+     * @param {number} index The zero-based paragraph insertion index.
+     * @param {string} text The paragraph text. Defaults to an empty paragraph.
+     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @returns {FDocumentParagraph} The inserted paragraph facade instance.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.insertParagraph(0, 'Document title');
+     * paragraph.appendText(' suffix');
+     *
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * const headerParagraph = fDocument.insertParagraph(0, 'Header title', headerSegmentId);
+     * headerParagraph.appendText(' suffix');
+     * ```
+     */
+    insertParagraph(index: number, text?: string, segmentId?: string): FDocumentParagraph;
+    /**
+     * Append a plain-text paragraph at the end of the body.
+     * @param {string} text The paragraph text. Defaults to an empty paragraph.
+     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @returns {FDocumentParagraph} The appended paragraph wrapper.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * const paragraph = fDocument.appendParagraph('Summary');
+     * console.log(paragraph.getText());
+     *
+     * const footerSegmentId = fDocument.ensurePageFooter();
+     * const footerParagraph = fDocument.appendParagraph('Confidential', footerSegmentId);
+     * console.log(footerParagraph.getText());
+     * ```
+     */
+    appendParagraph(text?: string, segmentId?: string): FDocumentParagraph;
+    /**
+     * Delete a range from the body.
+     * @param {IFDocumentTextRange} range The text range to delete.
+     * @returns {boolean} `true` if the range was deleted.
+     * @example
+     * ```ts
+     * const fDocument = univerAPI.getActiveDocument();
+     * fDocument.deleteRange({ startOffset: 0, endOffset: 5 });
+     *
+     * const headerSegmentId = fDocument.ensurePageHeader();
+     * fDocument.deleteRange({ startOffset: 0, endOffset: 5, segmentId: headerSegmentId });
+     * ```
+     */
+    deleteRange(range: IFDocumentTextRange): boolean;
+    private _createFDocumentParagraph;
+    private _normalizeDeleteRange;
+    private _getParagraphInsertOffset;
+    private _ensureHeaderFooter;
+    private _getHeaderFooterCreateInfo;
 }

package/lib/types/facade/f-enum.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { ColumnSeparatorType, SectionType } from '@univerjs/core';
+import { FEnum } from '@univerjs/core/facade';
+/** @ignore */
+export interface IFDocsEnumMixin {
+    /** OOXML-compatible section start types. */
+    SectionType: typeof SectionType;
+    /** Section column separator types. */
+    ColumnSeparatorType: typeof ColumnSeparatorType;
+}
+export declare class FDocsEnumMixin extends FEnum implements IFDocsEnumMixin {
+    get SectionType(): typeof SectionType;
+    get ColumnSeparatorType(): typeof ColumnSeparatorType;
+}
+declare module '@univerjs/core/facade' {
+    interface FEnum extends IFDocsEnumMixin {
+    }
+}

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

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export type FDocEmbedUnitFacadeMapAugmentation = never;

package/lib/types/facade/index.d.ts

@@ -14,10 +14,15 @@
  * limitations under the License.
  */
 import './f-univer';
+import './f-enum';
 export { FDocument } from './f-document';
-export { FDocumentBlockRange } from './f-document-block-range';
-export { FDocumentBody, type IFDocumentTextRange } from './f-document-body';
-export { FDocumentCustomBlock } from './f-document-custom-block';
-export { FDocumentElement } from './f-document-element';
-export { FDocumentParagraph } from './f-document-paragraph';
-export { FDocumentTable } from './f-document-table';
+export { FDocumentParagraph, isParagraphFacade } from './f-document-paragraph';
+export type { IFDocumentParagraphInfo } from './f-document-paragraph';
+export { DocsSectionUnsupportedDocumentFlavorError, FDocumentSection } from './f-document-section';
+export type { IFDocumentSectionColumnOptions, IFDocumentSectionDescription } from './f-document-section';
+export { FDocumentTextRange } from './f-document-text-range';
+export type { IFDocumentTextRangeDescription, IFDocumentTextStyleRun } from './f-document-text-range';
+export * from './f-enum';
+export type { FDocEmbedUnitFacadeMapAugmentation } from './f-types';
+export type { IFDocumentTextRange } from './utils';
+export { stripBlockTokens } from './utils';

package/lib/types/facade/utils.d.ts

@@ -13,12 +13,26 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IDocumentBody, IParagraphStyle } from '@univerjs/core';
+import type { DocumentDataModel, IDocumentBody, Injector, IParagraphStyle, UpdateDocsAttributeType } from '@univerjs/core';
 export interface IBuildPlainTextInsertBodyOptions {
     paragraphStyle?: IParagraphStyle;
     removeLeadingParagraphBreak?: boolean;
 }
+/**
+ * A text range in a document segment. Offsets are zero-based positions in the segment data stream.
+ */
+export interface IFDocumentTextRange {
+    /** The inclusive start offset of the range. */
+    startOffset: number;
+    /** The exclusive end offset of the range. */
+    endOffset: number;
+    /** The header/footer segment id. Omit or use an empty string for the main body. */
+    segmentId?: string;
+}
 export declare function getRemovedLeadingParagraphBreakLength(dataStream: string, removeLeadingParagraphBreak?: boolean): number;
 export declare function getNormalizedPlainTextCursorOffset(dataStream: string, cursorOffset: number, removeLeadingParagraphBreak?: boolean): number;
 export declare function getParagraphStyleAtOffset(body: IDocumentBody, offset: number): IParagraphStyle | undefined;
 export declare function buildPlainTextInsertBody(dataStream: string, options?: IBuildPlainTextInsertBodyOptions): IDocumentBody;
+export declare function replaceBodyRange(range: IFDocumentTextRange, insertBody: IDocumentBody, docDataModel: DocumentDataModel, injector: Injector): boolean;
+export declare function retainBodyRange(range: IFDocumentTextRange, updateBody: IDocumentBody, coverType: UpdateDocsAttributeType, docDataModel: DocumentDataModel, injector: Injector): boolean;
+export declare function stripBlockTokens(text: string): string;

package/lib/types/index.d.ts

@@ -15,14 +15,24 @@
  */
 export { DeleteTextCommand, InsertTextCommand, UpdateTextCommand } from './commands/commands/core-editing.command';
 export type { IDeleteTextCommandParams, IInsertTextCommandParams, IUpdateTextCommandParams, } from './commands/commands/core-editing.command';
+export { CreateHeaderFooterCommand, HeaderFooterType } from './commands/commands/create-header-footer.command';
+export type { HeaderFooterCreateMode, ICreateHeaderFooterCommandParams, IHeaderFooterProps, } from './commands/commands/create-header-footer.command';
+export { SetDocumentDefaultParagraphStyleCommand } from './commands/commands/set-document-default-paragraph-style.command';
+export type { IDocumentDefaultParagraphStylePatch, ISetDocumentDefaultParagraphStyleCommandParams, } from './commands/commands/set-document-default-paragraph-style.command';
+export { SetSectionHeaderFooterLinkCommand } from './commands/commands/set-section-header-footer-link.command';
+export type { ISetSectionHeaderFooterLinkCommandParams } from './commands/commands/set-section-header-footer-link.command';
+export { DeleteDocumentSectionBreakCommand, InsertDocumentSectionBreakCommand, UpdateDocumentSectionCommand } from './commands/commands/update-document-section.command';
+export type { IDeleteDocumentSectionBreakCommandParams, IDocumentSectionConfig, IDocumentSectionUpdate, IInsertDocumentSectionBreakCommandParams, IUpdateDocumentSectionCommandParams } from './commands/commands/update-document-section.command';
 export { RichTextEditingMutation } from './commands/mutations/core-editing.mutation';
 export type { IRichTextEditingMutationParams } from './commands/mutations/core-editing.mutation';
 export { SetTextSelectionsOperation } from './commands/operations/text-selection.operation';
 export type { ISetTextSelectionsOperationParams } from './commands/operations/text-selection.operation';
 export type { IUniverDocsConfig } from './config/config';
+export { createDocsCustomBlockDrawing, createDocsCustomBlockInsertMutation, createDocsCustomBlockRemoveMutation, createEmbedDocsCustomBlockData, createInsertCustomBlockActions, createRemoveCustomBlockActions, EMBED_DOCS_CUSTOM_BLOCK_DEFAULT_COMPONENT_KEY, isEmbedDocsCustomBlockData, isSheetLikeDocsCustomBlockChildType, resolveDocsCustomBlockSize, shouldUseInlineTextSelectionForDocsCustomBlockDrawing, } from './embed-host-anchor';
+export type { EmbedDocsCustomBlockInteractionMode, IDocsCustomBlockMutationParams, IEmbedDocsCustomBlockData, } from './embed-host-anchor';
 export { UniverDocsPlugin } from './plugin';
 export { DocBlockMoveValidatorService } from './services/doc-block-move-validator.service';
-export type { DocBlockMoveTransformer, DocBlockMoveValidator, IDocBlockMoveResult, IDocBlockMoveTransformContext, IDocBlockMoveValidationContext } from './services/doc-block-move-validator.service';
+export type { DocBlockMoveTransformer, DocBlockMoveValidator, IDocBlockMoveResult, IDocBlockMoveTransformContext, IDocBlockMoveValidationContext, } from './services/doc-block-move-validator.service';
 export { DocContentInsertService } from './services/doc-content-insert.service';
 export type { IDocContentInsertRange } from './services/doc-content-insert.service';
 export { DocInterceptorService } from './services/doc-interceptor/doc-interceptor.service';
@@ -33,4 +43,8 @@ export { DocStateChangeManagerService, IDocStateChangeInterceptorService, } from
 export type { IDocStateChangeInfo, IDocStateChangeParams } from './services/doc-state-emit.service';
 export { DocStateEmitService } from './services/doc-state-emit.service';
 export { addCustomRangeBySelectionFactory, addCustomRangeFactory, deleteCustomRangeFactory, } from './utils/custom-range-factory';
+export { generateParagraphs } from './utils/paragraphs';
 export { replaceSelectionFactory } from './utils/replace-selection-factory';
+export { createSectionColumnProperties } from './utils/section-columns';
+export { getTopLevelSectionBreaks } from './utils/sections';
+export { consumeContentInsertRange, isHeaderFooterSelection } from './utils/util';

package/lib/types/utils/paragraphs.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IParagraph, IParagraphBorder } from '@univerjs/core';
+/** Builds paragraph metadata for inserted paragraph tokens, including horizontal-rule borders. */
+export declare function generateParagraphs(dataStream: string, prevParagraph?: IParagraph, borderBottom?: IParagraphBorder, existingParagraphIds?: Iterable<string>): IParagraph[];

package/lib/types/utils/section-columns.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDocumentStyle, ISectionBreak, ISectionColumnProperties } from '@univerjs/core';
+/** Creates explicit OOXML section columns from a count, gap, and optional widths. */
+export declare function createSectionColumnProperties(documentStyle: IDocumentStyle | undefined, section: ISectionBreak | undefined, columnCount: number, gap: number, widths?: number[]): ISectionColumnProperties[];

package/lib/types/utils/sections.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDocumentBody, ISectionBreak } from '@univerjs/core';
+/** Returns document-level section breaks, excluding table-cell and modern-column sentinels. */
+export declare function getTopLevelSectionBreaks(body: IDocumentBody): ISectionBreak[];

package/lib/types/utils/util.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IAccessor } from '@univerjs/core';
+import type { ITextRangeWithStyle } from '@univerjs/engine-render';
+export declare function consumeContentInsertRange(accessor: IAccessor, unitId: string): import("..").IDocContentInsertRange | null;
+export declare function isHeaderFooterSelection(range?: ITextRangeWithStyle): boolean;