@extend-ai/react-docx 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1,6 +1,531 @@
 import * as React from 'react';
-import { DocModel, ImageRunNode, FormFieldRunNode, ParagraphNode, TextRunNode, ParagraphStyleDefinition, HeadingLevel, ParagraphAlignment } from '@extend-ai/react-docx-doc-model';
-import { LayoutOptions } from '@extend-ai/react-docx-layout-engine';
+
+interface OoxmlPart {
+    name: string;
+    content: string;
+}
+interface OoxmlPackage {
+    parts: Map<string, OoxmlPart>;
+    binaryAssets: Map<string, Uint8Array>;
+}
+declare function parseDocx(input: ArrayBuffer): Promise<OoxmlPackage>;
+declare function packageToArrayBuffer(pkg: OoxmlPackage): ArrayBuffer;
+declare function createMinimalDocxPackage(documentXml?: string): OoxmlPackage;
+declare function getPart(pkg: OoxmlPackage, partName: string): OoxmlPart | undefined;
+declare function withPart(pkg: OoxmlPackage, part: OoxmlPart): OoxmlPackage;
+
+type ParagraphAlignment = "left" | "center" | "right" | "justify";
+type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+interface TextRunBorderStyle {
+    type: string;
+    color?: string;
+    sizeEighthPt?: number;
+    spacePt?: number;
+    frame?: boolean;
+    shadow?: boolean;
+}
+interface TextStyle {
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strike?: boolean;
+    color?: string;
+    highlight?: string;
+    backgroundColor?: string;
+    fontSizePt?: number;
+    fontFamily?: string;
+    characterSpacingTwips?: number;
+    verticalAlign?: "superscript" | "subscript";
+    runBorder?: TextRunBorderStyle;
+}
+interface TextRunNode {
+    type: "text";
+    text: string;
+    style?: TextStyle;
+    link?: string;
+    noteReference?: {
+        kind: "footnote" | "endnote";
+        id: number;
+    };
+}
+interface ImageRunNode {
+    type: "image";
+    src?: string;
+    alt?: string;
+    widthPx?: number;
+    heightPx?: number;
+    partName?: string;
+    contentType?: string;
+    data?: Uint8Array;
+    sourceXml?: string;
+    crop?: {
+        leftFraction?: number;
+        topFraction?: number;
+        rightFraction?: number;
+        bottomFraction?: number;
+    };
+    cssFilter?: string;
+    cssOpacity?: number;
+    floating?: {
+        xPx?: number;
+        yPx?: number;
+        horizontalAlign?: "left" | "center" | "right" | "inside" | "outside";
+        verticalAlign?: "top" | "center" | "bottom" | "inside" | "outside";
+        horizontalRelativeTo?: string;
+        verticalRelativeTo?: string;
+        distLPx?: number;
+        distRPx?: number;
+        distTPx?: number;
+        distBPx?: number;
+        wrapType?: "none" | "square" | "tight" | "through" | "topAndBottom";
+        wrapText?: "bothSides" | "left" | "right" | "largest";
+        behindDocument?: boolean;
+        zIndex?: number;
+    };
+    syntheticTextBox?: boolean;
+    textBoxText?: string;
+}
+type FormFieldType = "checkbox" | "text" | "date" | "dropdown";
+type FormFieldSourceKind = "sdt" | "legacy";
+interface FormFieldOption {
+    displayText: string;
+    value?: string;
+}
+interface FormFieldTextWidgetSettings {
+    inputType?: "regular" | "number" | "date" | "currentDate" | "currentTime" | "calculated" | (string & {});
+    defaultText?: string;
+    maxLength?: number;
+    textFormat?: string;
+}
+interface FormFieldCheckboxWidgetSettings {
+    defaultChecked?: boolean;
+    sizeMode?: "auto" | "exact";
+    sizePt?: number;
+}
+interface FormFieldDropdownWidgetSettings {
+    defaultValue?: string;
+}
+interface FormFieldWidgetSettings {
+    name?: string;
+    enabled?: boolean;
+    calcOnExit?: boolean;
+    text?: FormFieldTextWidgetSettings;
+    checkbox?: FormFieldCheckboxWidgetSettings;
+    dropdown?: FormFieldDropdownWidgetSettings;
+}
+interface FormFieldRunNode {
+    type: "form-field";
+    fieldType: FormFieldType;
+    sourceKind?: FormFieldSourceKind;
+    id?: number;
+    tag?: string;
+    title?: string;
+    placeholder?: string;
+    checked?: boolean;
+    value?: string;
+    options?: FormFieldOption[];
+    widget?: FormFieldWidgetSettings;
+    checkedSymbol?: string;
+    uncheckedSymbol?: string;
+    style?: TextStyle;
+    link?: string;
+    sourceXml?: string;
+}
+type ParagraphChildNode = TextRunNode | ImageRunNode | FormFieldRunNode;
+interface ParagraphNumbering {
+    numId: number;
+    ilvl: number;
+}
+interface ParagraphSpacing {
+    beforeTwips?: number;
+    afterTwips?: number;
+    lineTwips?: number;
+    lineRule?: "auto" | "exact" | "atLeast";
+}
+interface ParagraphIndent {
+    leftTwips?: number;
+    rightTwips?: number;
+    firstLineTwips?: number;
+    hangingTwips?: number;
+}
+interface ParagraphBorderStyle {
+    type: string;
+    color?: string;
+    sizeEighthPt?: number;
+    spacePt?: number;
+    frame?: boolean;
+    shadow?: boolean;
+}
+interface ParagraphBorderSet {
+    top?: ParagraphBorderStyle;
+    right?: ParagraphBorderStyle;
+    bottom?: ParagraphBorderStyle;
+    left?: ParagraphBorderStyle;
+    between?: ParagraphBorderStyle;
+    bar?: ParagraphBorderStyle;
+}
+interface ParagraphStyle {
+    align?: ParagraphAlignment;
+    headingLevel?: HeadingLevel;
+    styleId?: string;
+    styleName?: string;
+    numbering?: ParagraphNumbering;
+    spacing?: ParagraphSpacing;
+    indent?: ParagraphIndent;
+    backgroundColor?: string;
+    borders?: ParagraphBorderSet;
+    tabStops?: ParagraphTabStop[];
+    contextualSpacing?: boolean;
+    keepNext?: boolean;
+    keepLines?: boolean;
+    widowControl?: boolean;
+    pageBreakBefore?: boolean;
+    dropCap?: {
+        type: "drop" | "margin";
+        lines?: number;
+        wrap?: string;
+        horizontalAnchor?: string;
+        verticalAnchor?: string;
+        xTwips?: number;
+        yTwips?: number;
+        horizontalSpaceTwips?: number;
+        verticalSpaceTwips?: number;
+    };
+}
+interface ParagraphNode {
+    type: "paragraph";
+    children: ParagraphChildNode[];
+    style?: ParagraphStyle;
+    paragraphMarkDeleted?: boolean;
+    sourceXml?: string;
+}
+interface TableBoxSpacing {
+    topTwips?: number;
+    rightTwips?: number;
+    bottomTwips?: number;
+    leftTwips?: number;
+}
+interface TableBorderStyle {
+    type: string;
+    color?: string;
+    sizeEighthPt?: number;
+}
+interface TableBorderSet {
+    top?: TableBorderStyle;
+    right?: TableBorderStyle;
+    bottom?: TableBorderStyle;
+    left?: TableBorderStyle;
+    insideH?: TableBorderStyle;
+    insideV?: TableBorderStyle;
+    tl2br?: TableBorderStyle;
+    tr2bl?: TableBorderStyle;
+}
+interface TableCellStyle {
+    backgroundColor?: string;
+    gridSpan?: number;
+    rowSpan?: number;
+    vMergeContinuation?: boolean;
+    widthTwips?: number;
+    marginTwips?: TableBoxSpacing;
+    verticalAlign?: "top" | "center" | "bottom";
+    borders?: TableBorderSet;
+}
+type TableCellContentNode = ParagraphNode | TableNode;
+interface TableCellNode {
+    type: "table-cell";
+    nodes: TableCellContentNode[];
+    style?: TableCellStyle;
+}
+interface TableRowStyle {
+    backgroundColor?: string;
+    heightTwips?: number;
+    heightRule?: "auto" | "atLeast" | "exact";
+    cantSplit?: boolean;
+}
+interface TableRowNode {
+    type: "table-row";
+    cells: TableCellNode[];
+    style?: TableRowStyle;
+}
+interface TableStyle {
+    widthTwips?: number;
+    indentTwips?: number;
+    layout?: "fixed" | "autofit";
+    cellSpacingTwips?: number;
+    cellMarginTwips?: TableBoxSpacing;
+    columnWidthsTwips?: number[];
+    borders?: TableBorderSet;
+    floating?: {
+        xTwips?: number;
+        yTwips?: number;
+        leftFromTextTwips?: number;
+        rightFromTextTwips?: number;
+        topFromTextTwips?: number;
+        bottomFromTextTwips?: number;
+        horizontalAnchor?: string;
+        verticalAnchor?: string;
+        horizontalAlign?: "left" | "center" | "right" | "inside" | "outside";
+        verticalAlign?: "top" | "center" | "bottom" | "inside" | "outside";
+    };
+}
+interface TableNode {
+    type: "table";
+    rows: TableRowNode[];
+    style?: TableStyle;
+    sourceXml?: string;
+}
+type DocNode = ParagraphNode | TableNode;
+interface HeaderSection {
+    partName: string;
+    referenceType?: string;
+    nodes: DocNode[];
+}
+interface FooterSection {
+    partName: string;
+    referenceType?: string;
+    nodes: DocNode[];
+}
+interface DocumentSection {
+    startNodeIndex: number;
+    sectionPropertiesXml?: string;
+    headerSections: HeaderSection[];
+    footerSections: FooterSection[];
+}
+interface ParagraphStyleDefinition {
+    id: string;
+    name: string;
+    basedOnId?: string;
+    nextStyleId?: string;
+    align?: ParagraphAlignment;
+    headingLevel?: HeadingLevel;
+    numbering?: ParagraphNumbering;
+    spacing?: ParagraphSpacing;
+    indent?: ParagraphIndent;
+    backgroundColor?: string;
+    borders?: ParagraphBorderSet;
+    tabStops?: ParagraphTabStop[];
+    contextualSpacing?: boolean;
+    keepNext?: boolean;
+    keepLines?: boolean;
+    widowControl?: boolean;
+    pageBreakBefore?: boolean;
+    runStyle?: TextStyle;
+    uiPriority?: number;
+    isDefault?: boolean;
+    isPrimary?: boolean;
+}
+interface NumberingLevelDefinition {
+    ilvl: number;
+    start?: number;
+    format?: string;
+    text?: string;
+    suffix?: "tab" | "space" | "nothing";
+    indent?: ParagraphIndent;
+    runStyle?: TextStyle;
+    bulletFontFamily?: string;
+    bulletColor?: string;
+    pictureBulletId?: number;
+    pictureBullet?: NumberingPictureBulletDefinition;
+}
+interface NumberingAbstractDefinition {
+    abstractNumId: number;
+    levels: NumberingLevelDefinition[];
+}
+interface NumberingInstanceDefinition {
+    numId: number;
+    abstractNumId: number;
+    levelStartOverrides?: Record<string, number>;
+    levelOverrides?: NumberingLevelDefinition[];
+}
+interface NumberingDefinitionSet {
+    abstracts: NumberingAbstractDefinition[];
+    instances: NumberingInstanceDefinition[];
+}
+interface NumberingPictureBulletDefinition {
+    numPicBulletId: number;
+    src?: string;
+    widthPx?: number;
+    heightPx?: number;
+    partName?: string;
+    contentType?: string;
+}
+interface DocumentNoteDefinition {
+    id: number;
+    text: string;
+    nodes?: DocNode[];
+}
+interface DocumentCompatibilitySettings {
+    suppressSpacingBeforeAfterPageBreak?: boolean;
+    usePrinterMetrics?: boolean;
+    useFixedHtmlParagraphSpacing?: boolean;
+    doNotBreakWrappedTables?: boolean;
+    doNotBreakConstrainedForcedTable?: boolean;
+    evenAndOddHeaders?: boolean;
+}
+interface DocModel {
+    nodes: DocNode[];
+    metadata: {
+        sourceParts: number;
+        warnings: string[];
+        documentPageCount?: number;
+        documentOpenTag?: string;
+        documentBackgroundColor?: string;
+        sectionPropertiesXml?: string;
+        sections?: DocumentSection[];
+        headerSections: HeaderSection[];
+        footerSections: FooterSection[];
+        paragraphStyles: ParagraphStyleDefinition[];
+        defaultParagraphStyleId?: string;
+        numberingDefinitions?: NumberingDefinitionSet;
+        compatibility?: DocumentCompatibilitySettings;
+        footnotes?: DocumentNoteDefinition[];
+        endnotes?: DocumentNoteDefinition[];
+    };
+}
+interface ContentTypeLookup {
+    defaultByExtension: Map<string, string>;
+    overrideByPartName: Map<string, string>;
+}
+interface ParseContext {
+    relationships: Map<string, string>;
+    contentTypes: ContentTypeLookup;
+    parts: OoxmlPackage["parts"];
+    binaryAssets: Map<string, Uint8Array>;
+    styleSheet: ParsedStyleSheet;
+    warnings: string[];
+}
+interface ThemeFontMap {
+    majorLatin?: string;
+    minorLatin?: string;
+    majorEastAsia?: string;
+    minorEastAsia?: string;
+    majorComplexScript?: string;
+    minorComplexScript?: string;
+}
+interface ThemeColorMap {
+    [token: ThemeColorToken]: string;
+}
+interface ParagraphTabStop {
+    alignment?: "left" | "center" | "right" | "decimal" | "bar";
+    leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
+    positionTwips?: number;
+}
+interface ParsedStyleSheet {
+    paragraphStyles: ParagraphStyleDefinition[];
+    paragraphStyleById: Map<string, ParagraphStyleDefinition>;
+    runStyleById: Map<string, TextStyle>;
+    tableStyleById: Map<string, ParsedTableStyleDefinition>;
+    defaultParagraphStyle?: ParagraphStyle;
+    defaultParagraphStyleId?: string;
+    defaultRunStyle?: TextStyle;
+    themeFonts: ThemeFontMap;
+    themeColors: ThemeColorMap;
+}
+type TableConditionalStyleType = "wholeTable" | "firstRow" | "lastRow" | "firstCol" | "lastCol" | "band1Horz" | "band2Horz" | "band1Vert" | "band2Vert" | "nwCell" | "neCell" | "swCell" | "seCell";
+interface ParsedTableStyleCondition {
+    rowBackgroundColor?: string;
+    cellBackgroundColor?: string;
+    paragraphAlign?: ParagraphAlignment;
+    runStyle?: TextStyle;
+    tableBorders?: TableBorderSet;
+    cellBorders?: TableBorderSet;
+    tableProperties?: ParsedTableProperties;
+    tableLook?: ParsedTableLook;
+}
+interface ParsedTableStyleDefinition {
+    id: string;
+    basedOnId?: string;
+    name: string;
+    conditions: Partial<Record<TableConditionalStyleType, ParsedTableStyleCondition>>;
+    floating?: NonNullable<TableStyle["floating"]>;
+    properties?: ParsedTableProperties;
+}
+interface ParsedTableProperties {
+    widthTwips?: number;
+    indentTwips?: number;
+    layout?: "fixed" | "autofit";
+    cellSpacingTwips?: number;
+    cellMarginTwips?: TableBoxSpacing;
+    floating?: NonNullable<TableStyle["floating"]>;
+}
+interface ParsedTableLook {
+    firstRow: boolean;
+    lastRow: boolean;
+    firstCol: boolean;
+    lastCol: boolean;
+    noHBand: boolean;
+    noVBand: boolean;
+    rowBandSize: number;
+    colBandSize: number;
+}
+declare function parseDocumentXml(documentXml: string, context?: ParseContext): DocNode[];
+declare function buildDocModel(pkg: OoxmlPackage): DocModel;
+declare function cloneDocModel(model: DocModel): DocModel;
+
+interface LayoutOptions {
+    pageWidth?: number;
+    pageHeight?: number;
+    margin?: number;
+    minLineHeight?: number;
+    paragraphSpacing?: number;
+    tableCellPadding?: number;
+}
+interface LayoutTextRun {
+    kind: "text";
+    id: string;
+    text: string;
+    style?: TextStyle;
+    link?: string;
+}
+interface LayoutImageRun {
+    kind: "image";
+    id: string;
+    src?: string;
+    alt?: string;
+    widthPx?: number;
+    heightPx?: number;
+    contentType?: string;
+    data?: Uint8Array;
+    floating?: boolean;
+}
+type LayoutRun = LayoutTextRun | LayoutImageRun;
+interface LayoutParagraphBlock {
+    kind: "paragraph";
+    id: string;
+    runs: LayoutRun[];
+    align: ParagraphAlignment;
+    headingLevel?: HeadingLevel;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface LayoutTableCell {
+    id: string;
+    colSpan?: number;
+    backgroundColor?: string;
+    paragraphs: LayoutParagraphBlock[];
+}
+interface LayoutTableRow {
+    id: string;
+    backgroundColor?: string;
+    cells: LayoutTableCell[];
+}
+interface LayoutTableBlock {
+    kind: "table";
+    id: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    rows: LayoutTableRow[];
+}
+type LayoutBlock = LayoutParagraphBlock | LayoutTableBlock;
+interface LayoutPage {
+    number: number;
+    blocks: LayoutBlock[];
+}
+declare function layoutDocument(model: DocModel, options?: LayoutOptions): LayoutPage[];
 
 interface DocumentLayoutMetrics {
     pageWidthPx: number;
@@ -298,6 +823,7 @@ interface DocxEditorViewerProps {
     editor: DocxEditorController;
     className?: string;
     style?: React.CSSProperties;
+    pageBackgroundColor?: string;
     pageGapBackgroundColor?: string;
     deferInitialPaginationPaint?: boolean;
     loadingState?: React.ReactNode;
@@ -402,8 +928,46 @@ interface DocxPaginationInfo {
 interface UseDocxPaginationResult {
     pagination: DocxPaginationInfo;
 }
+interface DocxPageThumbnailResolutionOptions {
+    sourceWidthPx: number;
+    sourceHeightPx: number;
+    maxWidthPx?: number;
+    maxHeightPx?: number;
+    pixelRatio?: number;
+}
+interface DocxPageThumbnailResolution {
+    widthPx: number;
+    heightPx: number;
+    pixelWidthPx: number;
+    pixelHeightPx: number;
+    scale: number;
+}
+interface UseDocxPageThumbnailsOptions {
+    maxWidthPx?: number;
+    maxHeightPx?: number;
+    pixelRatio?: number;
+    disabled?: boolean;
+}
+type DocxPageThumbnailStatus = "idle" | "rendering" | "ready" | "unavailable" | "error";
+interface DocxPageThumbnailItem extends DocxPageThumbnailResolution {
+    pageIndex: number;
+    pageNumber: number;
+    sourceWidthPx: number;
+    sourceHeightPx: number;
+    isMounted: boolean;
+    status: DocxPageThumbnailStatus;
+    error?: Error;
+    canvasRef: (canvas: HTMLCanvasElement | null) => void;
+    renderToCanvas: (canvas: HTMLCanvasElement) => Promise<void>;
+}
+interface UseDocxPageThumbnailsResult {
+    thumbnails: DocxPageThumbnailItem[];
+    rerenderAttachedThumbnails: () => Promise<void>;
+}
 declare const defaultStarterModel: DocModel;
 declare function useDocxEditor(options?: UseDocxEditorOptions): DocxEditorController;
+declare function resolveDocxPageThumbnailResolution(options: DocxPageThumbnailResolutionOptions): DocxPageThumbnailResolution;
+declare function useDocxPageThumbnails(editor: DocxEditorController, options?: UseDocxPageThumbnailsOptions): UseDocxPageThumbnailsResult;
 declare function useDocxDocumentTheme(editor: Pick<DocxEditorController, "documentTheme" | "setDocumentTheme">): UseDocxDocumentThemeResult;
 declare function useDocxParagraphStyles(editor: Pick<DocxEditorController, "availableParagraphStyles" | "selectedParagraphStyleId" | "setParagraphStyle">): UseDocxParagraphStylesResult;
 declare function useDocxImageWrapMenu(menu: Pick<DocxContextMenuRenderProps, "context" | "runAction">): UseDocxImageWrapMenuResult | undefined;
@@ -413,7 +977,255 @@ declare function useDocxFormFields(editor: Pick<DocxEditorController, "model" |
 declare function useDocxTrackChanges(editor: Pick<DocxEditorController, "trackedChanges" | "showTrackedChanges" | "setShowTrackedChanges" | "toggleShowTrackedChanges">): UseDocxTrackChangesResult;
 declare function useDocxPageLayout(editor: Pick<DocxEditorController, "model">): UseDocxPageLayoutResult;
 declare function useDocxPagination(editor: Pick<DocxEditorController, "currentPage" | "totalPages">): UseDocxPaginationResult;
-declare function DocxEditorViewer({ editor, className, style, pageGapBackgroundColor, deferInitialPaginationPaint, loadingState, pageVirtualization, visiblePageRange, onPageCountChange, onRequestPageReveal, headingStyles, showTrackedChanges, renderTrackedChangeCard, renderTableContextMenu, renderContextMenu, onFormFieldDoubleClick, mode, }: DocxEditorViewerProps): React.JSX.Element;
+declare function DocxEditorViewer({ editor, className, style, pageBackgroundColor, pageGapBackgroundColor, deferInitialPaginationPaint, loadingState, pageVirtualization, visiblePageRange, onPageCountChange, onRequestPageReveal, headingStyles, showTrackedChanges, renderTrackedChangeCard, renderTableContextMenu, renderContextMenu, onFormFieldDoubleClick, mode, }: DocxEditorViewerProps): React.JSX.Element;
+
+interface InsertParagraphOptions {
+    paragraphStyle?: ParagraphStyle;
+    runStyle?: TextStyle;
+}
+interface UpdateTextOptions {
+    insertedStyle?: TextStyle;
+}
+declare function splitParagraphChildrenAtTextOffsets(paragraph: ParagraphNode, text: string, startOffset: number, endOffset: number, options?: {
+    beforeInsertedStyle?: TextStyle;
+    afterInsertedStyle?: TextStyle;
+}): {
+    beforeChildren: ParagraphNode["children"];
+    afterChildren: ParagraphNode["children"];
+};
+declare function insertParagraph(model: DocModel, text: string, index?: number, options?: InsertParagraphOptions): DocModel;
+declare function removeParagraph(model: DocModel, index: number): DocModel;
+declare function duplicateParagraph(model: DocModel, index: number): DocModel;
+declare function updateParagraphText(model: DocModel, index: number, text: string, options?: UpdateTextOptions): DocModel;
+declare function updateTableCellText(model: DocModel, tableIndex: number, rowIndex: number, cellIndex: number, text: string, options?: UpdateTextOptions): DocModel;
+declare function updateTableCellParagraphText(model: DocModel, tableIndex: number, rowIndex: number, cellIndex: number, paragraphIndex: number, text: string, options?: UpdateTextOptions): DocModel;
+declare function updateTableCellParagraphTextRecursive(model: DocModel, tableIndex: number, rowIndex: number, cellIndex: number, paragraphIndex: number, text: string, options?: UpdateTextOptions): DocModel;
+declare function replaceText(model: DocModel, searchValue: string | RegExp, replacement: string): DocModel;
+declare function setParagraphHeading(model: DocModel, nodeIndex: number, headingLevel?: HeadingLevel): DocModel;
+declare function setParagraphAlignment(model: DocModel, nodeIndex: number, align?: ParagraphAlignment): DocModel;
+declare function applyRunStyle(model: DocModel, nodeIndex: number, runIndex: number, style: Partial<TextStyle>): DocModel;
+declare function toggleRunStyleFlag(model: DocModel, nodeIndex: number, runIndex: number, key: "bold" | "italic" | "underline" | "strike"): DocModel;
+declare function setRunHighlight(model: DocModel, nodeIndex: number, runIndex: number, highlight?: string): DocModel;
+declare function setRunColor(model: DocModel, nodeIndex: number, runIndex: number, color?: string): DocModel;
+declare function copyParagraphs(model: DocModel, startIndex: number, endIndex?: number): ParagraphNode[];
+declare function pasteParagraphs(model: DocModel, index: number, paragraphs: ParagraphNode[]): DocModel;
+declare function serializeParagraphsForClipboard(paragraphs: ParagraphNode[]): string;
+declare function parseParagraphsFromClipboard(input: string): ParagraphNode[] | undefined;
+
+interface ResolvedModelSection {
+    startNodeIndex: number;
+    sectionPropertiesXml?: string;
+    headerSections: HeaderSection[];
+    footerSections: FooterSection[];
+}
+interface PaginationSectionMetrics {
+    startNodeIndex: number;
+    pageContentWidthPx: number;
+    pageContentHeightPx: number;
+    docGridLinePitchPx?: number;
+}
+interface TableExplicitPageBreakInfo {
+    startRowIndexes: number[];
+    breakAfterTable: boolean;
+}
+interface DocumentPageRange {
+    startNodeIndex: number;
+    endNodeIndex: number;
+}
+declare function sectionBreakPropertiesStartNewPage(sectionPropertiesXml: string): boolean;
+declare function paragraphHasExplicitPageBreak(paragraph: ParagraphNode): boolean;
+declare function paragraphHasPageBreakBefore(paragraph: ParagraphNode): boolean;
+declare function sectionBreakAfterParagraphStartsNewPage(paragraph: ParagraphNode): boolean;
+declare function paragraphHasLastRenderedPageBreak(paragraph: ParagraphNode): boolean;
+declare function paragraphStartsWithLastRenderedPageBreak(paragraph: ParagraphNode): boolean;
+declare function paragraphBeforeSpacingPx(paragraph: ParagraphNode): number;
+declare function paragraphAfterSpacingPx(paragraph: ParagraphNode): number;
+declare function resolveParagraphBeforeSpacingPx(model: DocModel, nodeIndex: number, paragraph: ParagraphNode, pageConsumedHeightPx: number, suppressSpacingBeforeAfterPageBreak: boolean): number;
+declare function resolveDocumentSectionsFromMetadata(metadata: DocModel["metadata"]): ResolvedModelSection[];
+declare function sectionTitlePageEnabled(sectionPropertiesXml?: string): boolean;
+declare function selectSectionVariantForPage<T extends HeaderSection | FooterSection>(sections: T[], sectionPropertiesXml: string | undefined, pageIndex: number, options?: {
+    evenAndOddHeaders?: boolean;
+}): T | undefined;
+declare function resolveSectionIndexForNodeIndex(sections: Pick<ResolvedModelSection, "startNodeIndex">[], nodeIndex: number, previousSectionIndex: number): number;
+declare function resolveSectionPropertiesXmlForNodeIndex(sections: ResolvedModelSection[], nodeIndex: number, fallbackSectionPropertiesXml?: string): string | undefined;
+declare function resolvePaginationSectionMetricsIndexForNodeIndex(metricsBySection: PaginationSectionMetrics[], nodeIndex: number, previousSectionIndex: number): number;
+declare function scalePaginationSectionMetricsHeights(metricsBySection: PaginationSectionMetrics[], heightScale: number): PaginationSectionMetrics[];
+declare function collectTableExplicitPageBreakInfo(table: TableNode): TableExplicitPageBreakInfo;
+declare function collectTopLevelExplicitPageBreakStartNodeIndexes(nodes: DocModel["nodes"]): Set<number>;
+declare function collectDocxHardPageBreakStartNodeIndexes(model: DocModel): Set<number>;
+declare function collectDocxLastRenderedPageBreakStartNodeIndexes(model: DocModel): number[];
+declare function buildDocumentPageRanges(nodeCount: number, pageBreakStartNodeIndexes: Iterable<number>): DocumentPageRange[];
+
+declare const DEFAULT_PAGE_OVERFLOW_TOLERANCE_PX = 2;
+declare const DEFAULT_MIN_PARAGRAPH_LINE_HEIGHT_PX = 14;
+interface TableRowRange {
+    startRowIndex: number;
+    endRowIndex: number;
+}
+interface ParagraphLineRange {
+    startLineIndex: number;
+    endLineIndex: number;
+    totalLineCount: number;
+    lineHeightPx: number;
+}
+interface DocumentPageNodeSegment {
+    nodeIndex: number;
+    tableRowRange?: TableRowRange;
+    paragraphLineRange?: ParagraphLineRange;
+}
+interface LetterheadColumnSegmentGroup {
+    startOffset: number;
+    endOffset: number;
+    leftSegments: DocumentPageNodeSegment[];
+    rightSegments: DocumentPageNodeSegment[];
+}
+interface ParagraphSplitControlOptions {
+    allowKeepLinesOverflow?: boolean;
+    allowKeepNextOverflow?: boolean;
+}
+interface PageSegmentationCallbacks {
+    estimateDocNodeHeightPx: (node: DocModel["nodes"][number], availableWidthPx?: number, numberingDefinitions?: NumberingDefinitionSet, docGridLinePitchPx?: number) => number;
+    paragraphHasVisibleText: (paragraph: ParagraphNode) => boolean;
+    paragraphIsStructuralSectionBreakSpacer: (paragraph: ParagraphNode) => boolean;
+    estimateParagraphHeightPx: (paragraph: ParagraphNode, availableWidthPx?: number, numberingDefinitions?: NumberingDefinitionSet, docGridLinePitchPx?: number) => number;
+    estimateParagraphLineHeightPx: (paragraph: ParagraphNode, docGridLinePitchPx?: number) => number;
+    paragraphLineCountWithinWidth: (paragraph: ParagraphNode, availableWidthPx?: number, numberingDefinitions?: NumberingDefinitionSet) => number;
+    paragraphWidowControlEnabled: (paragraph: ParagraphNode) => boolean;
+    paragraphCanSplitAcrossPages: (paragraph: ParagraphNode, lineCount: number, options?: ParagraphSplitControlOptions) => boolean;
+    estimateTableRowHeightsPx: (table: TableNode, maxAvailableWidthPx?: number, numberingDefinitions?: NumberingDefinitionSet, docGridLinePitchPx?: number) => number[];
+}
+interface OverflowBreakCollectionOptions {
+    suppressSpacingBeforeAfterPageBreak?: boolean;
+    pageOverflowTolerancePx?: number;
+}
+interface DocumentPageSegmentationOptions extends OverflowBreakCollectionOptions {
+    allowParagraphLineSplitting?: boolean;
+    measuredTableRowHeightsByNodeIndex?: Record<number, number[]>;
+    measuredPageContentHeightsPxByPageIndex?: number[];
+    minParagraphLineHeightPx?: number;
+    preferLastRenderedParagraphStartBreaks?: boolean;
+}
+declare function paragraphLetterheadColumnGroupAtSegmentOffset(nodeSegments: DocumentPageNodeSegment[], startOffset: number, resolveFloatSideAtNodeIndex: (nodeIndex: number) => "left" | "right" | undefined): LetterheadColumnSegmentGroup | undefined;
+declare function collectDocxEstimatedOverflowBreakStartNodeIndexes(model: DocModel, hardBreakStartNodeIndexes: Set<number>, pageContentHeightPx: number, pageContentWidthPx: number, callbacks: PageSegmentationCallbacks, numberingDefinitions?: NumberingDefinitionSet, paginationMetricsBySection?: PaginationSectionMetrics[], options?: OverflowBreakCollectionOptions): Set<number>;
+declare function buildDocumentPageNodeSegments(model: DocModel, pageContentHeightPx: number, pageContentWidthPx: number, callbacks: PageSegmentationCallbacks, numberingDefinitions?: NumberingDefinitionSet, paginationMetricsBySection?: PaginationSectionMetrics[], options?: DocumentPageSegmentationOptions): DocumentPageNodeSegment[][];
+declare function resolveDocumentPageSegmentStartNodeIndex(pageSegments: DocumentPageNodeSegment[]): number | undefined;
+declare function scorePaginationAgainstStoredPageBreaks(pages: DocumentPageNodeSegment[][], storedBreakStartNodeIndexes: number[]): number;
+
+type LayoutSnapshotOptions = LayoutOptions;
+interface LayoutSnapshotRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface LayoutSnapshotPageSize {
+    width: number;
+    height: number;
+}
+interface LayoutSnapshotMargins {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+interface ResolvedLayoutMetrics {
+    pageSizePx: LayoutSnapshotPageSize;
+    marginsPx: LayoutSnapshotMargins;
+    contentBoxPx: LayoutSnapshotRect;
+}
+interface ResolvedDocumentSection {
+    index: number;
+    startNodeIndex: number;
+    synthetic: boolean;
+    layout: ResolvedLayoutMetrics;
+}
+interface ResolvedDocument {
+    source: "layout-engine-adapter";
+    nodeCount: number;
+    pageCountHint?: number;
+    layout: ResolvedLayoutMetrics;
+    sections: ResolvedDocumentSection[];
+    metadata: {
+        sourceParts: number;
+        warningCount: number;
+        warnings: string[];
+        headerSectionCount: number;
+        footerSectionCount: number;
+    };
+}
+interface LayoutFragmentSource {
+    kind: "paragraph" | "table" | "table-cell" | "table-cell-paragraph";
+    nodeIndex: number;
+    rowIndex?: number;
+    cellIndex?: number;
+    paragraphIndex?: number;
+}
+interface LayoutSnapshotTextRun {
+    kind: "text";
+    id: string;
+    text: string;
+    style?: TextStyle;
+    link?: string;
+}
+interface LayoutSnapshotImageRun {
+    kind: "image";
+    id: string;
+    src?: string;
+    alt?: string;
+    widthPx?: number;
+    heightPx?: number;
+    floating?: boolean;
+}
+type LayoutSnapshotRun = LayoutSnapshotTextRun | LayoutSnapshotImageRun;
+interface LayoutSnapshotParagraphFragment {
+    kind: "paragraph";
+    id: string;
+    framePx: LayoutSnapshotRect;
+    align: ParagraphAlignment;
+    headingLevel?: HeadingLevel;
+    runs: LayoutSnapshotRun[];
+    source?: LayoutFragmentSource;
+}
+interface LayoutSnapshotTableCellFragment {
+    id: string;
+    colSpan?: number;
+    backgroundColor?: string;
+    paragraphs: LayoutSnapshotParagraphFragment[];
+    source?: LayoutFragmentSource;
+}
+interface LayoutSnapshotTableRowFragment {
+    id: string;
+    backgroundColor?: string;
+    cells: LayoutSnapshotTableCellFragment[];
+}
+interface LayoutSnapshotTableFragment {
+    kind: "table";
+    id: string;
+    framePx: LayoutSnapshotRect;
+    rows: LayoutSnapshotTableRowFragment[];
+    source?: LayoutFragmentSource;
+}
+type LayoutSnapshotBlockFragment = LayoutSnapshotParagraphFragment | LayoutSnapshotTableFragment;
+interface LayoutSnapshotPage {
+    index: number;
+    number: number;
+    pageSizePx: LayoutSnapshotPageSize;
+    marginsPx: LayoutSnapshotMargins;
+    contentBoxPx: LayoutSnapshotRect;
+    blocks: LayoutSnapshotBlockFragment[];
+}
+interface LayoutSnapshot {
+    version: 1;
+    source: "layout-engine-adapter";
+    resolvedDocument: ResolvedDocument;
+    pages: LayoutSnapshotPage[];
+}
+declare function resolveDocumentForLayout(model: DocModel, options?: LayoutSnapshotOptions): ResolvedDocument;
+declare function buildLayoutSnapshot(model: DocModel, options?: LayoutSnapshotOptions): LayoutSnapshot;
+
+declare function modelToDocumentXml(model: DocModel, basePackage?: OoxmlPackage): string;
+declare function serializeDocModel(model: DocModel, basePackage?: OoxmlPackage): OoxmlPackage;
+declare function serializeDocx(model: DocModel, basePackage?: OoxmlPackage): ArrayBuffer;
 
 interface ReactDocxViewerProps {
     file?: ArrayBuffer;
@@ -430,4 +1242,4 @@ interface UseDocxModelState {
 declare function useDocxModel(file?: ArrayBuffer): UseDocxModelState;
 declare function ReactDocxViewer({ file, model, className, layoutOptions, emptyState }: ReactDocxViewerProps): React.JSX.Element;
 
-export { type DocxBorderContext, type DocxBorderPreset, type DocxBorderPresetState, type DocxContextMenuAction, type DocxContextMenuActionId, type DocxContextMenuContext, type DocxContextMenuRenderProps, type DocxDocumentTheme, type DocxEditorController, type DocxEditorSelection, DocxEditorViewer, type DocxEditorViewerMode, type DocxEditorViewerProps, type DocxFormFieldLocation, type DocxHeadingStyleMap, type DocxImageDropTarget, type DocxImageLocation, type DocxImageWrapMenuOption, type DocxImageWrapMode, type DocxImageWrapState, type DocxLineSpacingInfo, type DocxListType, type DocxPageLayoutInfo, type DocxPaginationInfo, type DocxSectionColumnLayout, type DocxSelectedFormField, type DocxTableContextMenuAction, type DocxTableContextMenuActionId, type DocxTableContextMenuContext, type DocxTableContextMenuRenderProps, type DocxTextRange, type DocxTextRangeLocation, type DocxTrackedChange, type DocxTrackedChangeCardRenderProps, type DocxTrackedChangeKind, ReactDocxViewer, type ReactDocxViewerProps, type UseDocxBordersResult, type UseDocxDocumentThemeResult, type UseDocxEditorOptions, type UseDocxFormFieldsResult, type UseDocxImageWrapMenuResult, type UseDocxLineSpacingResult, type UseDocxModelState, type UseDocxPageLayoutResult, type UseDocxPaginationResult, type UseDocxParagraphStylesResult, type UseDocxTrackChangesResult, defaultStarterModel, paragraphLetterheadFloatSideAtNodeIndex, parseSectionLayout, resolveDocumentLayout, useDocxBorders, useDocxDocumentTheme, useDocxEditor, useDocxFormFields, useDocxImageWrapMenu, useDocxLineSpacing, useDocxModel, useDocxPageLayout, useDocxPagination, useDocxParagraphStyles, useDocxTrackChanges };
+export { DEFAULT_MIN_PARAGRAPH_LINE_HEIGHT_PX, DEFAULT_PAGE_OVERFLOW_TOLERANCE_PX, type DocModel, type DocNode, type DocumentCompatibilitySettings, type DocumentNoteDefinition, type DocumentPageNodeSegment, type DocumentPageRange, type DocumentPageSegmentationOptions, type DocumentSection, type DocxBorderContext, type DocxBorderPreset, type DocxBorderPresetState, type DocxContextMenuAction, type DocxContextMenuActionId, type DocxContextMenuContext, type DocxContextMenuRenderProps, type DocxDocumentTheme, type DocxEditorController, type DocxEditorSelection, DocxEditorViewer, type DocxEditorViewerMode, type DocxEditorViewerProps, type DocxFormFieldLocation, type DocxHeadingStyleMap, type DocxImageDropTarget, type DocxImageLocation, type DocxImageWrapMenuOption, type DocxImageWrapMode, type DocxImageWrapState, type DocxLineSpacingInfo, type DocxListType, type DocxPageLayoutInfo, type DocxPageThumbnailItem, type DocxPageThumbnailResolution, type DocxPageThumbnailResolutionOptions, type DocxPageThumbnailStatus, type DocxPaginationInfo, type DocxSectionColumnLayout, type DocxSelectedFormField, type DocxTableContextMenuAction, type DocxTableContextMenuActionId, type DocxTableContextMenuContext, type DocxTableContextMenuRenderProps, type DocxTextRange, type DocxTextRangeLocation, type DocxTrackedChange, type DocxTrackedChangeCardRenderProps, type DocxTrackedChangeKind, type FooterSection, type FormFieldCheckboxWidgetSettings, type FormFieldDropdownWidgetSettings, type FormFieldOption, type FormFieldRunNode, type FormFieldSourceKind, type FormFieldTextWidgetSettings, type FormFieldType, type FormFieldWidgetSettings, type HeaderSection, type HeadingLevel, type ImageRunNode, type InsertParagraphOptions, type LayoutBlock, type LayoutFragmentSource, type LayoutImageRun, type LayoutOptions, type LayoutPage, type LayoutParagraphBlock, type LayoutRun, type LayoutSnapshot, type LayoutSnapshotBlockFragment, type LayoutSnapshotImageRun, type LayoutSnapshotMargins, type LayoutSnapshotOptions, type LayoutSnapshotPage, type LayoutSnapshotPageSize, type LayoutSnapshotParagraphFragment, type LayoutSnapshotRect, type LayoutSnapshotRun, type LayoutSnapshotTableCellFragment, type LayoutSnapshotTableFragment, type LayoutSnapshotTableRowFragment, type LayoutSnapshotTextRun, type LayoutTableBlock, type LayoutTableCell, type LayoutTableRow, type LayoutTextRun, type LetterheadColumnSegmentGroup, type NumberingAbstractDefinition, type NumberingDefinitionSet, type NumberingInstanceDefinition, type NumberingLevelDefinition, type NumberingPictureBulletDefinition, type OoxmlPackage, type OoxmlPart, type OverflowBreakCollectionOptions, type PageSegmentationCallbacks, type PaginationSectionMetrics, type ParagraphAlignment, type ParagraphBorderSet, type ParagraphBorderStyle, type ParagraphChildNode, type ParagraphIndent, type ParagraphLineRange, type ParagraphNode, type ParagraphNumbering, type ParagraphSpacing, type ParagraphSplitControlOptions, type ParagraphStyle, type ParagraphStyleDefinition, ReactDocxViewer, type ReactDocxViewerProps, type ResolvedDocument, type ResolvedDocumentSection, type ResolvedLayoutMetrics, type ResolvedModelSection, type TableBorderSet, type TableBorderStyle, type TableBoxSpacing, type TableCellContentNode, type TableCellNode, type TableCellStyle, type TableExplicitPageBreakInfo, type TableNode, type TableRowNode, type TableRowRange, type TableRowStyle, type TableStyle, type TextRunBorderStyle, type TextRunNode, type TextStyle, type UpdateTextOptions, type UseDocxBordersResult, type UseDocxDocumentThemeResult, type UseDocxEditorOptions, type UseDocxFormFieldsResult, type UseDocxImageWrapMenuResult, type UseDocxLineSpacingResult, type UseDocxModelState, type UseDocxPageLayoutResult, type UseDocxPageThumbnailsOptions, type UseDocxPageThumbnailsResult, type UseDocxPaginationResult, type UseDocxParagraphStylesResult, type UseDocxTrackChangesResult, applyRunStyle, buildDocModel, buildDocumentPageNodeSegments, buildDocumentPageRanges, buildLayoutSnapshot, cloneDocModel, collectDocxEstimatedOverflowBreakStartNodeIndexes, collectDocxHardPageBreakStartNodeIndexes, collectDocxLastRenderedPageBreakStartNodeIndexes, collectTableExplicitPageBreakInfo, collectTopLevelExplicitPageBreakStartNodeIndexes, copyParagraphs, createMinimalDocxPackage, defaultStarterModel, duplicateParagraph, getPart, insertParagraph, layoutDocument, modelToDocumentXml, packageToArrayBuffer, paragraphAfterSpacingPx, paragraphBeforeSpacingPx, paragraphHasExplicitPageBreak, paragraphHasLastRenderedPageBreak, paragraphHasPageBreakBefore, paragraphLetterheadColumnGroupAtSegmentOffset, paragraphLetterheadFloatSideAtNodeIndex, paragraphStartsWithLastRenderedPageBreak, parseDocumentXml, parseDocx, parseParagraphsFromClipboard, parseSectionLayout, pasteParagraphs, removeParagraph, replaceText, resolveDocumentForLayout, resolveDocumentLayout, resolveDocumentPageSegmentStartNodeIndex, resolveDocumentSectionsFromMetadata, resolveDocxPageThumbnailResolution, resolvePaginationSectionMetricsIndexForNodeIndex, resolveParagraphBeforeSpacingPx, resolveSectionIndexForNodeIndex, resolveSectionPropertiesXmlForNodeIndex, scalePaginationSectionMetricsHeights, scorePaginationAgainstStoredPageBreaks, sectionBreakAfterParagraphStartsNewPage, sectionBreakPropertiesStartNewPage, sectionTitlePageEnabled, selectSectionVariantForPage, serializeDocModel, serializeDocx, serializeParagraphsForClipboard, setParagraphAlignment, setParagraphHeading, setRunColor, setRunHighlight, splitParagraphChildrenAtTextOffsets, toggleRunStyleFlag, updateParagraphText, updateTableCellParagraphText, updateTableCellParagraphTextRecursive, updateTableCellText, useDocxBorders, useDocxDocumentTheme, useDocxEditor, useDocxFormFields, useDocxImageWrapMenu, useDocxLineSpacing, useDocxModel, useDocxPageLayout, useDocxPageThumbnails, useDocxPagination, useDocxParagraphStyles, useDocxTrackChanges, withPart };