@betteroffice/docx 0.0.1

package/dist/rustDisplayList-dqunvwxH.d.mts

@@ -0,0 +1,1036 @@
+import { a as Layout } from './types-DNrYr6yQ.mjs';
+import { M as MeasuredBlock } from './measuredBlock-DZwz8zhD.mjs';
+import { Z as DrawingScene, b0 as ShapeTextBodyProperties } from './content-sSHuWw49.mjs';
+import { x as TextModernEffects } from './formatting-DoL7KBSL.mjs';
+
+interface DisplayList {
+    /** Contract version. Undefined reads as legacy version 0. */
+    contractVersion?: number;
+    pages: DisplayPage[];
+}
+/**
+ * Modern (`w14:*`) run text-effect payload carried on text/glyph primitives.
+ * Same shape as the document model's `TextModernEffects` — px distances,
+ * degree directions, 0..1 opacities, resolved `#rrggbb` colors.
+ */
+type DisplayTextModernEffects = TextModernEffects;
+interface DisplayPage {
+    pageIndex: number;
+    width: number;
+    height: number;
+    /** Authored body content box (page-local px), derived from page margins. */
+    contentBounds?: DisplayBounds;
+    /** Authored body column boxes in reading order (page-local px). */
+    columnBounds?: DisplayBounds[];
+    /** Stable section identity for this page. Undefined = legacy/global section. */
+    sectionId?: string;
+    /** Zero-based section ordinal. */
+    sectionIndex?: number;
+    /** Zero-based page ordinal within the section. */
+    sectionPageIndex?: number;
+    /** Effective page number within the section, after any restart. */
+    sectionPageNumber?: number;
+    /** Formatted PAGE label (for example, "vii"). */
+    pageLabel?: string;
+    primitives: DisplayPrimitive[];
+    /** Resolved page background. Undefined = transparent/host white. */
+    background?: string;
+    pageBorders?: PageBorderPrimitive[];
+    header?: HfRegion;
+    footer?: HfRegion;
+    /** Footnote/endnote regions in page coordinates. Undefined = none. */
+    noteAreas?: NoteRegion[];
+}
+/** A page-local rectangle emitted as display-list metadata. */
+interface DisplayBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/** Page note region; primitives retain normal doc/a11y metadata. */
+interface NoteRegion {
+    kind?: 'footnote' | 'endnote';
+    sectionId?: string;
+    y?: number;
+    height?: number;
+    columns?: number;
+    separatorPrimitives?: DisplayPrimitive[];
+    primitives?: DisplayPrimitive[];
+    noteIds?: number[];
+    /**
+     * Per-note backlink metadata (W17): the body-doc PM range of each note's
+     * reference mark plus its formatted label, so the a11y mirror can wire
+     * note ↔ reference associations (doc-noteref / doc-backlink). Parallel to
+     * `noteIds`; undefined = legacy region without backlink data.
+     */
+    notes?: NoteRegionNote[];
+}
+/** Backlink metadata for one note in a NoteRegion. */
+interface NoteRegionNote {
+    id?: number;
+    /** Body-doc PM range of the reference mark anchoring this note. */
+    anchorDocStart?: number;
+    anchorDocEnd?: number;
+    /** Formatted reference label (display number / custom mark). File-derived. */
+    label?: string;
+}
+interface HfRegion {
+    rId: string;
+    kind: 'header' | 'footer';
+    y: number;
+    height: number;
+    primitives: DisplayPrimitive[];
+}
+type DisplayPrimitive = TextRunPrimitive | GlyphRunPrimitive | RectPrimitive | LinePrimitive | ImagePrimitive | ShapePrimitive | DecorationPrimitive;
+interface TableCellRef {
+    row: number;
+    col: number;
+    rowSpan: number;
+    colSpan: number;
+    continuation?: boolean;
+    /** Stable semantic cell identity. */
+    cellId?: string;
+    /** Cell participates as a row/column header. */
+    isHeader?: boolean;
+    /** Header cell was repeated on a continuation page. */
+    repeatedHeader?: boolean;
+    /** Word `w:noWrap` cell behavior. */
+    noWrap?: boolean;
+    /** IDs of header cells that label this data cell. */
+    headerIds?: string[];
+    /** Collapsed-border ownership retained for exact fragment replay. */
+    ownsTopBorder?: boolean;
+    ownsRightBorder?: boolean;
+    ownsBottomBorder?: boolean;
+    ownsLeftBorder?: boolean;
+}
+/** Table-fragment semantics shared by every primitive emitted for that fragment. */
+interface DisplayTableMetadata {
+    tableId?: string;
+    rowStart?: number;
+    rowEnd?: number;
+    rowCount?: number;
+    columnCount?: number;
+    headerRowCount?: number;
+    caption?: string;
+    description?: string;
+    parentTableId?: string;
+}
+/** Resolved review presentation for the primitive's `commentIds`. */
+interface DisplayCommentMetadata {
+    status?: 'active' | 'resolved';
+    authorId?: string;
+    paletteIndex?: number;
+    color?: string;
+    selected?: boolean;
+    /** Reviewer display name (file-derived, attacker-controlled). */
+    authorName?: string;
+    /** Comment date string, passed through verbatim. */
+    date?: string;
+    /** Plain-text comment body excerpt (builder-capped, file-derived). */
+    text?: string;
+    /** Number of replies in the thread. */
+    replyCount?: number;
+    /** Reply summaries in thread order (builder-capped). */
+    replies?: DisplayCommentReply[];
+}
+/** One reply summary inside DisplayCommentMetadata. */
+interface DisplayCommentReply {
+    authorName?: string;
+    date?: string;
+    text?: string;
+}
+/**
+ * Inert field identity for a11y announcement. `instruction` is the raw Word
+ * field instruction, carried for announcement/inspection ONLY — it is never
+ * parsed into behavior or executed by any consumer (see the repo security guidelines security).
+ */
+interface DisplayFieldMetadata {
+    /** Painter-resolved category (PAGE, NUMPAGES, DATE, TIME, OTHER). */
+    category?: string;
+    /** Raw Word field type token (e.g. TOC, PAGEREF, REF). */
+    type?: string;
+    /** Raw field instruction text (announce-only, builder-capped). */
+    instruction?: string;
+}
+/** Footnote/endnote reference identity on the body reference-mark primitive. */
+interface DisplayNoteRef {
+    kind?: 'footnote' | 'endnote';
+    id?: number;
+}
+/** Scoped clip/group membership emitted by the Rust compiler. */
+interface DisplayClipGroupMetadata {
+    id?: string;
+    clip?: {
+        x?: number;
+        y?: number;
+        w?: number;
+        h?: number;
+    };
+    opacity?: number;
+}
+interface StructuralRevision {
+    scope: 'pmark' | 'table' | 'row' | 'cell';
+    author: string;
+    date?: string;
+    revisionId: string;
+    kind: 'ins' | 'del' | 'merge';
+    rowIndex?: number;
+    colIndex?: number;
+}
+interface SdtAttrs {
+    groupId: string;
+    sdtType: string;
+    depth?: number;
+    tag?: string;
+    alias?: string;
+    lock?: string;
+    checked?: boolean;
+    bound?: boolean;
+    repeatingItem?: boolean;
+}
+interface InlineSdtWidgetAttrs {
+    kind: 'checkbox';
+    /** Rich control kind. Undefined = legacy checkbox. */
+    controlKind?: 'checkbox' | 'dropDownList' | 'comboBox' | 'date' | 'picture' | 'repeatingSection';
+    groupId: string;
+    pos: number;
+    tag?: string;
+    alias?: string;
+    checked?: boolean;
+    controlId?: number;
+    value?: string;
+    selectedIndex?: number;
+    listItems?: Array<{
+        displayText?: string;
+        value?: string;
+    }>;
+    dateFormat?: string;
+    dateLanguage?: string;
+    locked?: boolean;
+}
+interface ChartA11yAttrs {
+    label: string;
+}
+interface DocAttrs {
+    docStart?: number;
+    docEnd?: number;
+    blockId?: number;
+    blockKey?: string;
+    fragmentDocStart?: number;
+    fragmentDocEnd?: number;
+    paraId?: string;
+    fromLine?: number;
+    toLine?: number;
+    /**
+     * Table cell the primitive paints inside, when any. The a11y mirror builds
+     * real ARIA table semantics (role table/row/cell, aria-row/colindex) from
+     * this — without it a table block reads as a flat run of text.
+     */
+    cell?: TableCellRef;
+    /** Sanitized hyperlink target when this primitive paints linked content. */
+    href?: string;
+    /** Optional hyperlink tooltip/title for popup UI. */
+    tooltip?: string;
+    /** ScreenTip exposed as DOM `title`; undefined falls back to `tooltip`. */
+    linkTitle?: string;
+    /** Safe hyperlink target frame. */
+    linkTarget?: string;
+    /** Link history bit. Undefined = host-unmanaged. */
+    linkHistory?: boolean;
+    /** Location within the target document. */
+    linkDocLocation?: string;
+    commentIds?: string[];
+    /**
+     * Inert field identity when this primitive paints a field result. The a11y
+     * mirror announces it (data-field-* + aria-description); nothing executes it.
+     */
+    field?: DisplayFieldMetadata;
+    /**
+     * Footnote/endnote reference identity when this primitive is the body
+     * reference mark — the mirror renders it as a doc-noteref link to the
+     * note's mirror element (W17 backlinks).
+     */
+    noteRef?: DisplayNoteRef;
+    revision?: {
+        author: string;
+        date: string;
+        revisionId: string;
+        kind: 'ins' | 'del';
+    };
+    /** Synthetic numbering glyph for the first line of a list paragraph. */
+    listMarker?: boolean;
+    /** Pending suggestion paint for a synthetic numbering glyph. */
+    listMarkerRevision?: 'ins' | 'del';
+    structuralRevision?: StructuralRevision;
+    /** Innermost block-level content-control identity for this primitive. */
+    sdt?: SdtAttrs;
+    /** Full outer-to-inner content-control ancestry. */
+    sdtPath?: SdtAttrs[];
+    /** Inline content-control widget metadata when this text run is its glyph. */
+    inlineSdtWidget?: InlineSdtWidgetAttrs;
+    /** Accessibility summary for primitives that compose one chart block. */
+    chart?: ChartA11yAttrs;
+    /** Logical/source order, independent of visual bidi paint order. */
+    logicalOrder?: number;
+    /** Resolved bidi embedding level. */
+    bidiLevel?: number;
+    /** BCP-47 language for a11y/font fallback. */
+    lang?: string;
+    /** Decorative content is omitted from the accessibility mirror. */
+    decorative?: boolean;
+    /** Authored accessibility name. */
+    ariaLabel?: string;
+    /** Authored accessibility description. */
+    ariaDescription?: string;
+    /** Hidden authored object. Undefined = visible. */
+    hiddenObject?: boolean;
+    /** Stable logical scene/group identity. */
+    groupId?: string;
+    /** Review presentation for comment-associated primitives. */
+    comment?: DisplayCommentMetadata;
+    /**
+     * Scoped clip/group membership. Undefined = ungrouped. Kept as metadata
+     * until the canvas/mirror batch activates `ClipGroupPrimitive` in the union.
+     */
+    clipGroup?: DisplayClipGroupMetadata;
+    /** Enclosing table-fragment identity and accessibility semantics. */
+    table?: DisplayTableMetadata;
+}
+interface TextRunPrimitive extends DocAttrs {
+    kind: 'text';
+    text: string;
+    x: number;
+    baselineY: number;
+    width: number;
+    font: string;
+    color: string;
+    letterSpacing?: number;
+    wordSpacing?: number;
+    rtl?: boolean;
+    /** 0..1 alpha applied only to this run. Absent = opaque. */
+    opacity?: number;
+    /** Degrees clockwise around the primitive's geometry center. Absent = 0. */
+    rotationDeg?: number;
+    /** Horizontal text scale as a percentage (100 = normal). Absent = 100. */
+    horizontalScale?: number;
+    /** Render glyphs uppercase without changing the accessible source text. */
+    allCaps?: boolean;
+    /** Render lowercase glyphs as small uppercase. */
+    smallCaps?: boolean;
+    /** Hidden run shown in editing view as dimmed/dotted, matching the DOM painter. */
+    hidden?: boolean;
+    /** CSS-like shadow effect ported from run formatting. */
+    textShadow?: 'shadow' | 'emboss' | 'imprint';
+    /** Outlined / hollow text. */
+    textOutline?: boolean;
+    /** CJK emphasis mark. */
+    emphasisMark?: 'dot' | 'comma' | 'circle' | 'underDot';
+    /** Legacy text-effect class hook for the a11y mirror. */
+    textEffect?: 'blinkBackground' | 'lights' | 'antsBlack' | 'antsRed' | 'shimmer' | 'sparkle';
+    /** Modern w14 text effects (glow/shadow/reflection/textFill/textOutline). */
+    modernEffects?: DisplayTextModernEffects;
+    /** Shaped tab/TOC leader metadata. Undefined = ordinary text. */
+    leaderGlyphs?: Omit<LeaderGlyphPrimitive, 'kind'>;
+}
+interface PositionedGlyph {
+    id: number;
+    x: number;
+    y: number;
+    cluster: number;
+    advance?: number;
+    /** Logical cluster order before bidi reordering. */
+    logicalOrder?: number;
+    /** Bidi embedding level for this cluster. */
+    bidiLevel?: number;
+}
+interface GlyphRunPrimitive extends DocAttrs {
+    kind: 'glyphRun';
+    fontId: number;
+    size: number;
+    color: string;
+    text: string;
+    glyphs: PositionedGlyph[];
+    fallbackFont?: string;
+    wordSpacing?: number;
+    rtl?: boolean;
+    /** 0..1 alpha applied only to this run. Absent = opaque. */
+    opacity?: number;
+    /** Degrees clockwise around the primitive's geometry center. Absent = 0. */
+    rotationDeg?: number;
+    /** Horizontal text scale as a percentage (100 = normal). Absent = 100. */
+    horizontalScale?: number;
+    /** Render glyphs uppercase without changing the accessible source text. */
+    allCaps?: boolean;
+    /** Render lowercase glyphs as small uppercase. */
+    smallCaps?: boolean;
+    /** Hidden run shown in editing view as dimmed/dotted, matching the DOM painter. */
+    hidden?: boolean;
+    /** CSS-like shadow effect ported from run formatting. */
+    textShadow?: 'shadow' | 'emboss' | 'imprint';
+    /** Outlined / hollow text. */
+    textOutline?: boolean;
+    /** CJK emphasis mark. */
+    emphasisMark?: 'dot' | 'comma' | 'circle' | 'underDot';
+    /** Legacy text-effect class hook for the a11y mirror. */
+    textEffect?: 'blinkBackground' | 'lights' | 'antsBlack' | 'antsRed' | 'shimmer' | 'sparkle';
+    /** Modern w14 text effects (glow/shadow/reflection/textFill/textOutline). */
+    modernEffects?: DisplayTextModernEffects;
+    /** Shaped tab/TOC leader metadata. Undefined = ordinary glyph run. */
+    leaderGlyphs?: Omit<LeaderGlyphPrimitive, 'kind'>;
+}
+interface RectPrimitive extends DocAttrs {
+    kind: 'rect';
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    fill: string;
+    /** Alpha multiplier. Undefined = 1. */
+    opacity?: number;
+}
+/** Word/CSS line recipe retained instead of flattening to a solid stroke. */
+type DisplayBorderStyle = 'solid' | 'double' | 'dotted' | 'dashed' | 'dashDot' | 'dashDotDot' | 'triple' | 'thinThick' | 'thickThin' | 'wave' | 'doubleWave' | 'groove' | 'ridge' | 'inset' | 'outset';
+interface LinePrimitive extends DocAttrs {
+    kind: 'line';
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+    strokeWidth: number;
+    color: string;
+    dash?: number[];
+    role?: 'border' | 'table-border' | 'table-cut' | 'separator';
+    /** Full border recipe. Undefined = infer solid/dash from `dash`. */
+    borderStyle?: DisplayBorderStyle;
+    /** Secondary color for 3-D/multi-stroke recipes. */
+    secondaryColor?: string;
+    /** Alpha multiplier. Undefined = 1. */
+    opacity?: number;
+    /** Owner of the retained Word border recipe. */
+    borderOwner?: 'cell' | 'fragment' | 'paragraph' | 'textBox';
+}
+interface PageBorderSide {
+    width: number;
+    color: string;
+    style: 'solid' | 'double' | 'dotted' | 'dashed' | 'groove' | 'ridge' | 'inset' | 'outset';
+}
+interface PageBorderPrimitive {
+    kind: 'pageBorder';
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    zOrder?: 'front' | 'back';
+    top?: PageBorderSide;
+    right?: PageBorderSide;
+    bottom?: PageBorderSide;
+    left?: PageBorderSide;
+}
+interface ImagePrimitive extends DocAttrs {
+    kind: 'image';
+    relId: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    rotationDeg?: number;
+    /** 0..1 alpha applied only to this image. Absent = opaque. */
+    opacity?: number;
+    /** Flip about the content-frame center. Undefined = false. */
+    flipH?: boolean;
+    /** Flip about the content-frame center. Undefined = false. */
+    flipV?: boolean;
+    /** Original image frame when w/h are a transformed layout bbox. */
+    contentFrame?: {
+        x?: number;
+        y?: number;
+        w?: number;
+        h?: number;
+    };
+    /** Canvas/CSS filter string for renderer-owned effects, e.g. watermark washout. */
+    filter?: string;
+    /** True for decorative/non-content images such as picture watermarks. */
+    decorative?: boolean;
+    crop?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    altText?: string;
+    /** Ordered image effects. Undefined = use legacy `filter` only. */
+    effects?: Array<{
+        kind?: string;
+        amount?: number;
+        threshold?: number;
+        colors?: string[];
+        rawName?: string;
+    }>;
+    /** Picture border recipe. Undefined = none. */
+    border?: {
+        width?: number;
+        color?: string;
+        style?: string;
+        dash?: number[];
+    };
+}
+type ShapePathCommand = {
+    type: 'move';
+    x: number;
+    y: number;
+} | {
+    type: 'line';
+    x: number;
+    y: number;
+} | {
+    type: 'quad';
+    cpx: number;
+    cpy: number;
+    x: number;
+    y: number;
+} | {
+    type: 'cubic';
+    cp1x: number;
+    cp1y: number;
+    cp2x: number;
+    cp2y: number;
+    x: number;
+    y: number;
+} | {
+    type: 'close';
+};
+interface ShapePrimitive extends DocAttrs {
+    kind: 'shape';
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    /** Page-local path commands scaled from the shape's normalized geometry. */
+    geometryPath: ShapePathCommand[];
+    fill?: string;
+    stroke?: {
+        color: string;
+        width: number;
+        /** DrawingML/CSS dash style token. */
+        dash?: string;
+    };
+    transform?: {
+        rotation?: number;
+        flipH?: boolean;
+        flipV?: boolean;
+    };
+    /** True when the shape carries no accessible inner text. */
+    decorative?: boolean;
+    /** Alpha multiplier. Undefined = 1. */
+    opacity?: number;
+    /** Lossless paint server; undefined = legacy `fill`. */
+    fillPaint?: {
+        kind?: 'none' | 'solid' | 'gradient' | 'pattern' | 'picture' | 'theme';
+        color?: string;
+        angle?: number;
+        gradientType?: string;
+        stops?: Array<{
+            position?: number;
+            color?: string;
+        }>;
+        patternPreset?: string;
+        foregroundColor?: string;
+        backgroundColor?: string;
+        pictureRelId?: string;
+        /**
+         * Resolved SAFE embedded source for a picture fill (`blob:`/`data:` only —
+         * external-mode blip relationships are never resolved, so opening a file
+         * cannot trigger a network fetch). The canvas image resolver rejects any
+         * other scheme as defense in depth. Absent = unresolvable, paint the
+         * legacy `fill`/`color` instead.
+         */
+        pictureSrc?: string;
+        /** Picture source crop fractions (`a:srcRect`, 0..1; negative = outset). */
+        pictureSrcRect?: {
+            left?: number;
+            top?: number;
+            right?: number;
+            bottom?: number;
+        };
+        /** Picture fill mode. Absent = 'stretch' (`a:stretch`). */
+        pictureFillMode?: 'stretch' | 'tile';
+        /** Tile parameters when `pictureFillMode` = 'tile'. Offsets px, scales fractions. */
+        pictureTile?: {
+            offsetX?: number;
+            offsetY?: number;
+            scaleX?: number;
+            scaleY?: number;
+            alignment?: string;
+            flip?: 'none' | 'x' | 'y' | 'xy';
+        };
+        /** Stretch target rect fractions of the shape box (`a:fillRect`, 0..1). */
+        pictureStretchRect?: {
+            left?: number;
+            top?: number;
+            right?: number;
+            bottom?: number;
+        };
+        /** Picture alpha 0..1 (`a:alphaModFix`). Absent = opaque. */
+        pictureOpacity?: number;
+        themeRefIndex?: number;
+    };
+    /** Lossless DrawingML stroke details beyond the legacy `stroke` triple. */
+    strokePaint?: {
+        color?: string;
+        width?: number;
+        dash?: string;
+        customDash?: number[];
+        compound?: 'single' | 'double' | 'thickThin' | 'thinThick' | 'triple';
+        alignment?: 'center' | 'inset';
+        cap?: 'flat' | 'round' | 'square';
+        join?: 'bevel' | 'miter' | 'round';
+        miterLimit?: number;
+        headEnd?: {
+            type?: string;
+            width?: string;
+            length?: string;
+        };
+        tailEnd?: {
+            type?: string;
+            width?: string;
+            length?: string;
+        };
+    };
+    /** Ordered 2-D effects. Undefined = none. */
+    effects?: Array<{
+        kind?: string;
+        color?: string;
+        opacity?: number;
+        blurRadius?: number;
+        distance?: number;
+        direction?: number;
+        size?: number;
+        rawName?: string;
+    }>;
+    /** Effect extents in page px. Undefined = zero. */
+    effectExtent?: {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+    };
+    /** Versioned heterogeneous DrawingML group/canvas scene. */
+    drawingScene?: DrawingScene;
+    /** Full DrawingML `a:bodyPr` projection for shape text. */
+    textBodyProperties?: ShapeTextBodyProperties;
+}
+interface DecorationPrimitive extends DocAttrs {
+    kind: 'decoration';
+    deco: 'underline' | 'strike' | 'highlight' | 'comment-range' | 'spell';
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    color: string;
+    dashed?: boolean;
+    dotted?: boolean;
+    /** Exact highlight font-box/source slice. Undefined = legacy rect. */
+    highlightSlice?: {
+        sourceStart?: number;
+        sourceEnd?: number;
+        ascent?: number;
+        descent?: number;
+        includesTrailingWhitespace?: boolean;
+    };
+    /** Full border/decoration recipe. Undefined = solid/dashed/dotted flags. */
+    style?: DisplayBorderStyle;
+}
+/** Shaped tab/TOC leader glyphs; absent metrics mean no painted leader. */
+interface LeaderGlyphPrimitive extends DocAttrs {
+    /** Primitive tag. Undefined when embedded as run metadata. */
+    kind?: 'leaderGlyphs';
+    glyph?: string;
+    count?: number;
+    x?: number;
+    baselineY?: number;
+    advance?: number;
+    width?: number;
+    font?: string;
+    fontId?: number;
+    size?: number;
+    color?: string;
+    rtl?: boolean;
+}
+
+declare const FRAME_DELTA_VERSION = 1;
+declare const FRAME_DELTA_HEADER_BYTES = 80;
+declare const FRAME_DELTA_PAGE_OP_BYTES = 48;
+type FrameDeltaErrorCode = 'invalid-frame' | 'unsupported-version' | 'stale-frame' | 'base-mismatch';
+declare class FrameDeltaError extends Error {
+    readonly code: FrameDeltaErrorCode;
+    constructor(code: FrameDeltaErrorCode, message: string);
+}
+interface FramePageUpsert {
+    readonly kind: 'upsert';
+    readonly pageIndex: number;
+    readonly pageId: bigint;
+    readonly fingerprint: bigint;
+    /** Zero-copy view into {@link DecodedFrameDelta.bytes}. */
+    readonly primitiveIds: BigUint64Array;
+    readonly page: DisplayPage;
+}
+interface FramePageRemove {
+    readonly kind: 'remove';
+    readonly pageIndex: number;
+    readonly pageId: bigint;
+}
+interface FramePageMove {
+    readonly kind: 'move';
+    readonly pageIndex: number;
+    readonly pageId: bigint;
+    readonly fingerprint: bigint;
+}
+interface FramePrimitivePositionPatch {
+    readonly primitiveId: bigint;
+    readonly docStart?: number | null;
+    readonly docEnd?: number | null;
+    readonly fragmentDocStart?: number | null;
+    readonly fragmentDocEnd?: number | null;
+    readonly inlineWidgetPos?: number | null;
+}
+interface FramePagePositionPatch {
+    readonly kind: 'patch-positions';
+    readonly pageIndex: number;
+    readonly pageId: bigint;
+    readonly fingerprint: bigint;
+    readonly patches: readonly FramePrimitivePositionPatch[];
+}
+interface FramePositionShiftRun {
+    readonly start: number;
+    readonly count: number;
+    readonly changedMask: number;
+    readonly delta: number;
+}
+interface FramePagePositionShift {
+    readonly kind: 'shift-positions';
+    readonly pageIndex: number;
+    readonly pageId: bigint;
+    readonly fingerprint: bigint;
+    readonly runs: readonly FramePositionShiftRun[];
+}
+type FramePageOperation = FramePageUpsert | FramePageRemove | FramePageMove | FramePagePositionPatch | FramePagePositionShift;
+interface DecodedFrameDelta {
+    readonly protocolVersion: typeof FRAME_DELTA_VERSION;
+    readonly full: boolean;
+    readonly docEpoch: number;
+    readonly layoutEpoch: number;
+    readonly frameEpoch: number;
+    readonly baseFrameEpoch: number;
+    readonly pageCount: number;
+    readonly contractVersion?: number;
+    readonly operations: readonly FramePageOperation[];
+    /** Complete binary frame; safe to transfer when the caller owns its buffer. */
+    readonly bytes: Uint8Array;
+}
+interface RetainedFramePage {
+    readonly pageIndex: number;
+    readonly pageId: bigint;
+    readonly fingerprint: bigint;
+    readonly primitiveIds: BigUint64Array;
+    readonly page: DisplayPage;
+}
+interface RetainedFrame {
+    readonly protocolVersion: typeof FRAME_DELTA_VERSION;
+    readonly docEpoch: number;
+    readonly layoutEpoch: number;
+    readonly frameEpoch: number;
+    readonly contractVersion?: number;
+    readonly pages: readonly RetainedFramePage[];
+    /** IDs whose canvas/mirror/interactive projections must be replaced. */
+    readonly damagedPageIds: ReadonlySet<bigint>;
+    /** Removed surfaces, retained separately because they are absent from pages. */
+    readonly removedPageIds: ReadonlySet<bigint>;
+    readonly displayList: DisplayList;
+}
+/**
+ * Decode and fully validate one binary FrameDelta v1 without mutating retained
+ * browser state. Page payloads are typed values, not embedded JSON strings.
+ */
+declare function decodeFrameDelta(input: Uint8Array | ArrayBuffer): DecodedFrameDelta;
+/** Apply one already-validated frame atomically, rejecting stale generations. */
+declare function applyFrameDelta(previous: RetainedFrame | null, delta: DecodedFrameDelta): RetainedFrame;
+/**
+ * Apply a frame while reusing position-only page arenas owned exclusively by
+ * the caller. Worker/main resident-engine hot paths replace their outer frame
+ * atomically and have no concurrent readers; avoiding deep suffix clones keeps
+ * geometry shifts from creating periodic multi-megabyte GC stalls.
+ */
+declare function applyFrameDeltaOwned(previous: RetainedFrame | null, delta: DecodedFrameDelta): RetainedFrame;
+
+/**
+ * JS seam to the Rust display-list builder (crates/docx-layout).
+ *
+ * Marshals the same `{ measured, options, layout }` triple the golden
+ * fixtures pin (see scripts/export-displaylist-fixtures.ts) across the wasm
+ * boundary and parses the resulting DisplayList. All paint/geometry decisions
+ * happen in Rust — this module is serialization glue only.
+ *
+ * The wasm module is loaded lazily via dynamic import on first build, so the
+ * ~800KB inlined binary costs nothing until the experimental canvas renderer
+ * is actually enabled.
+ *
+ * @experimental part of the rust-canvas-engine change; shape may evolve.
+ */
+
+/**
+ * One header/footer part in the `headersFooters` envelope field: the measured
+ * blocks of the HF ProseMirror doc identified by `rId`, plus the band metrics
+ * `convertHeaderFooterPmDocToContent` computed (passed through verbatim — the
+ * Rust builder re-derives nothing).
+ */
+interface DisplayListHfVariant {
+    rId: string;
+    kind: 'header' | 'footer';
+    type: 'default' | 'first' | 'even';
+    /** `toMeasuredBlocks(content.blocks, content.measures)` — same schema as body `measured` */
+    measured: MeasuredBlock[];
+    /** HeaderFooterContent.height (in-flow stack incl. floating blocks) */
+    height: number;
+    /** HeaderFooterContent.flowHeight (in-flow band height; fallback: height) */
+    flowHeight?: number;
+    visualTop?: number;
+    visualBottom?: number;
+    /**
+     * Per-page resolved widths of PAGE/NUMPAGES field runs in this HF part, so a
+     * centered/right-aligned line carrying such a field re-centers per page. The
+     * line width is measured ONCE at the field's fallback text ("1"), so without
+     * this the builder holds the same centered position on every page even though
+     * "Page 2 of 3"/"Page 10 of 12" have different widths. Omitted ⇒ the fields
+     * ride the char-distributed fallback width (byte-identical to before).
+     */
+    fieldWidths?: DisplayListFieldWidths[];
+}
+/**
+ * Per-page widths of one PAGE/NUMPAGES field run in an HF part. `pmStart` is the
+ * field run's position in the HF ProseMirror doc (the key the Rust builder
+ * matches). `fallbackWidth` is the width the measure baked into `line.width`
+ * (the field's fallback text); `perPage[i]` is the width of the field's resolved
+ * text on layout page index `i` (PAGE → that page's number, NUMPAGES → total).
+ */
+interface DisplayListFieldWidths {
+    pmStart: number;
+    fallbackWidth: number;
+    perPage: number[];
+}
+/**
+ * Optional header/footer payload of the builder envelope. Absent ⇒ the Rust
+ * output is byte-identical to the body-only build. Flags come off the section
+ * properties / settings the DOM painter uses; distances are the same px the
+ * painter resolves (`headerDistance ?? page.margins.header ?? 48`).
+ */
+interface DisplayListHeadersFooters {
+    titlePg?: boolean;
+    evenAndOddHeaders?: boolean;
+    headerDistance?: number;
+    footerDistance?: number;
+    /** Page-level Word watermark, painted behind body/header/footer content. */
+    watermark?: DisplayListWatermark;
+    variants: DisplayListHfVariant[];
+    /** Stable section identity. Undefined = document-global legacy envelope. */
+    sectionId?: string;
+    /** Zero-based section index. */
+    sectionIndex?: number;
+}
+type DisplayListWatermark = DisplayListTextWatermark | DisplayListPictureWatermark;
+interface DisplayListTextWatermark {
+    kind: 'text';
+    text: string;
+    font: string;
+    color: string;
+    semitransparent: boolean;
+    layout: 'diagonal' | 'horizontal';
+    fontSize?: number;
+    /** Undefined defaults to true for watermarks. */
+    decorative?: boolean;
+}
+interface DisplayListPictureWatermark {
+    kind: 'picture';
+    relId?: string;
+    dataUrl?: string;
+    scale: number;
+    washout: boolean;
+    widthEmu?: number;
+    heightEmu?: number;
+    /** Undefined defaults to true for watermarks. */
+    decorative?: boolean;
+}
+/** One measured note in a page/section note area. */
+interface DisplayListNoteItem {
+    kind?: 'footnote' | 'endnote';
+    id?: number;
+    displayLabel?: string;
+    measured?: MeasuredBlock[];
+    height?: number;
+    anchorDocStart?: number;
+    anchorDocEnd?: number;
+    customMarkFollows?: boolean;
+}
+/** Typed non-fragmented note-region input for the Rust display builder. */
+interface DisplayListNoteArea {
+    pageIndex?: number;
+    sectionId?: string;
+    kind?: 'footnote' | 'endnote';
+    placement?: 'pageBottom' | 'beneathText' | 'sectEnd' | 'docEnd';
+    y?: number;
+    height?: number;
+    columns?: number;
+    separator?: DisplayListNoteItem;
+    notes?: DisplayListNoteItem[];
+}
+/** Stable reviewer palette entry for comments/revisions. */
+interface DisplayListCommentAuthor {
+    id?: string;
+    name?: string;
+    paletteIndex?: number;
+    color?: string;
+}
+/** One reply of a comment thread (a11y announcement input). */
+interface DisplayListCommentReply {
+    id?: number;
+    authorId?: string;
+    authorName?: string;
+    date?: string;
+    /** Plain-text body (the builder caps it before it reaches primitives). */
+    text?: string;
+}
+/**
+ * Per-comment thread metadata keyed by comment id, joined by the builder onto
+ * every primitive carrying that id in `commentIds` so the a11y mirror can
+ * announce the complete thread (author name, date, body, replies). All string
+ * values are file-derived/attacker-controlled; consumers must only ever
+ * assign them via textContent/setAttribute.
+ */
+interface DisplayListCommentThread {
+    /** Comment id — matches the numeric ids in `resolvedCommentIds`/`commentIds`. */
+    id?: number;
+    authorId?: string;
+    authorName?: string;
+    date?: string;
+    /** Plain-text body (builder-capped before emission). */
+    text?: string;
+    /** Replies in thread order (builder-capped count and text). */
+    replies?: DisplayListCommentReply[];
+}
+/** The `{ measured, options, layout }` envelope the Rust builder consumes. */
+interface DisplayListBuildInputs {
+    /** Serialization contract version. Undefined reads as legacy version 0. */
+    contractVersion?: number;
+    measured: MeasuredBlock[];
+    options: unknown;
+    layout: Layout;
+    /** header/footer parts + section flags; omitted ⇒ body-only display list */
+    headersFooters?: DisplayListHeadersFooters;
+    /**
+     * Doc-wide font-id chains keyed `"<family lowercase>|<bold 0|1>|<italic 0|1>"`
+     * → measurement `FontStore` ids — the SAME map the measurement input carries.
+     * Present only under Rust measurement (the ids must belong to a populated
+     * store); its presence against that store is what gates GlyphRun emission.
+     * Omitted ⇒ every text run takes the browser-measured `TextRunPrimitive` path
+     * (byte-identical to the pre-glyph build).
+     */
+    fontChains?: Record<string, number[]>;
+    /** Page/section note regions. Undefined = no note emission. */
+    noteAreas?: DisplayListNoteArea[];
+    /** Resolved comments suppressed from active tint. Undefined = none known. */
+    resolvedCommentIds?: number[];
+    /** Stable reviewer palette. Undefined = legacy hard-coded colors. */
+    commentAuthors?: DisplayListCommentAuthor[];
+    /** Per-comment thread metadata for a11y announcements. Undefined = none. */
+    commentThreads?: DisplayListCommentThread[];
+}
+/** Minimal engine surface, injectable so tests can fake the wasm module. */
+interface RustDisplayListEngine {
+    buildDisplayListJson(input: string): string;
+    /** Resident editing engines expose binary deltas; the stateless layout wasm does not. */
+    buildDisplayListFrame?(input: string, expectedFrameEpoch: number): Uint8Array;
+    /** One-owner ordinary input path; available on the resident editing engine. */
+    applyInput?(text: string, expectedFrameEpoch: number): Uint8Array;
+    displayHitTestRegionsJson?(pageIndex: number, x: number, y: number): string;
+    displayRangeRectsJson?(from: number, to: number): string;
+    displayRangeRectsRegionJson?(region: 'body' | 'header' | 'footer', rId: string, from: number, to: number): string;
+}
+type RustDisplayListSourceErrorStage = 'load' | 'build' | 'parse' | 'decode' | 'apply';
+interface RustDisplayFrameResult {
+    displayList: DisplayList;
+    /** Null only on the compatibility JSON engine path. */
+    frame: RetainedFrame | null;
+    transport: 'frame-delta-v1' | 'json';
+}
+/**
+ * Typed terminal error from the mandatory Rust display-list source. Hosts may
+ * surface this through their editor error boundary; it is never permission to
+ * silently substitute painter geometry.
+ */
+declare class RustDisplayListSourceError extends Error {
+    readonly stage: RustDisplayListSourceErrorStage;
+    constructor(stage: RustDisplayListSourceErrorStage, cause: unknown);
+}
+/**
+ * Query surface over an already-built display list, injectable so tests can
+ * fake the wasm module.
+ *
+ * The `*Json` calls take the display-list JSON string as an argument (the Rust
+ * side re-parses it per query — callers should cache the string). The
+ * session-handle members parse the list ONCE (`openDisplayList` → handle) and
+ * answer many queries by handle with no re-serialization, reusing the same
+ * hit/range logic so results are byte-identical. The handle members are
+ * OPTIONAL: the embedded wasm carries them only after the integrator re-embeds,
+ * so `createDisplayListQueries` feature-detects `hasDisplayListSession` and
+ * falls back to the `*Json` path when they are absent.
+ */
+interface RustDisplayListQueryEngine {
+    /** region-aware hit test → `{"region","rId"?,"pos"}` or `"null"` JSON */
+    hitTestRegionsJson(displayList: string, pageIndex: number, x: number, y: number): string;
+    /** body PM range → JSON array of `{pageIndex,x,y,width,height}` rects */
+    rangeRectsJson(displayList: string, from: number, to: number): string;
+    /**
+     * Region-aware PM range → JSON array of rects. `region` is
+     * `'body' | 'header' | 'footer'`; `rId` scopes header/footer to one HF part
+     * (empty for body / match-any). OPTIONAL: the embedded wasm carries it only
+     * after the integrator re-embeds, so `createDisplayListQueries` falls back to
+     * `[]` when absent (HF selection geometry stays a documented gap until then).
+     */
+    rangeRectsRegionJson?(displayList: string, region: string, rId: string, from: number, to: number): string;
+    /** true when the embedded wasm carries the region-aware range-rect exports */
+    hasRangeRectsRegion?(): boolean;
+    /** true when the embedded wasm carries the session-handle exports below */
+    hasDisplayListSession?(): boolean;
+    /** parse a display list once, return a handle for the by-handle queries */
+    openDisplayList?(displayList: string): number;
+    /** free a handle's parsed display list */
+    closeDisplayList?(handle: number): void;
+    /** region-aware hit test against a stored display list (by handle) */
+    hitTestRegionsByHandle?(handle: number, pageIndex: number, x: number, y: number): string;
+    /** body PM range against a stored display list (by handle) */
+    rangeRectsByHandle?(handle: number, from: number, to: number): string;
+    /** region-aware PM range against a stored display list (by handle) */
+    rangeRectsRegionByHandle?(handle: number, region: string, rId: string, from: number, to: number): string;
+}
+/**
+ * Lazily load the wasm query surface (hit-test + range-rects). Shares the
+ * module promise with `buildRustDisplayList`, so on the canvas-renderer path
+ * the engine is already resolved by the time the first display list lands.
+ */
+declare function loadRustDisplayListQueryEngine(): Promise<RustDisplayListQueryEngine>;
+/** Display-only fields sent to an engine that already retains pagination. */
+declare function encodeDisplayListFrameExtras(inputs: DisplayListBuildInputs): string;
+/**
+ * Build a DisplayList for a computed layout through the Rust engine. Throws
+ * when the wasm module fails to load or the builder rejects the input — the
+ * caller is expected to fall back to the DOM painter.
+ */
+declare function buildRustDisplayList(inputs: DisplayListBuildInputs, engine?: RustDisplayListEngine): Promise<DisplayList>;
+/**
+ * Production display build. Resident editing engines return FrameDelta v1;
+ * older/stateless engines retain the full-JSON parity path.
+ */
+declare function buildRustDisplayFrame(inputs: DisplayListBuildInputs, engine?: RustDisplayListEngine, previous?: RetainedFrame | null): Promise<RustDisplayFrameResult>;
+
+export { applyFrameDeltaOwned as A, buildRustDisplayFrame as B, buildRustDisplayList as C, type DisplayList as D, decodeFrameDelta as E, FRAME_DELTA_HEADER_BYTES as F, type GlyphRunPrimitive as G, type HfRegion as H, type ImagePrimitive as I, encodeDisplayListFrameExtras as J, loadRustDisplayListQueryEngine as K, type LinePrimitive as L, type PositionedGlyph as P, type RustDisplayListQueryEngine as R, type TextRunPrimitive as T, type DisplayListHeadersFooters as a, type DisplayPage as b, type DisplayPrimitive as c, type DecodedFrameDelta as d, type DecorationPrimitive as e, type DisplayBounds as f, type DisplayListBuildInputs as g, type DisplayListHfVariant as h, type DisplayListPictureWatermark as i, type DisplayListTextWatermark as j, type DisplayListWatermark as k, type DocAttrs as l, FRAME_DELTA_PAGE_OP_BYTES as m, FRAME_DELTA_VERSION as n, FrameDeltaError as o, type FrameDeltaErrorCode as p, type FramePageOperation as q, type RectPrimitive as r, type RetainedFrame as s, type RetainedFramePage as t, type RustDisplayFrameResult as u, type RustDisplayListEngine as v, RustDisplayListSourceError as w, type RustDisplayListSourceErrorStage as x, type TableCellRef as y, applyFrameDelta as z };