@zeke-02/docx-editor-core 0.1.0

package/dist/formatting-_OXU8gLB.d.ts

@@ -0,0 +1,410 @@
+import { C as ColorValue, S as ShadingProperties, B as BorderSpec } from './colors-C3vA7HUU.js';
+
+/**
+ * Text, Paragraph, and Table Formatting Types
+ *
+ * Properties that control how text, paragraphs, and table structures
+ * are formatted in OOXML (w:rPr, w:pPr, w:tblPr, etc.).
+ */
+
+/**
+ * Underline style options
+ */
+type UnderlineStyle = 'none' | 'single' | 'words' | 'double' | 'thick' | 'dotted' | 'dottedHeavy' | 'dash' | 'dashedHeavy' | 'dashLong' | 'dashLongHeavy' | 'dotDash' | 'dashDotHeavy' | 'dotDotDash' | 'dashDotDotHeavy' | 'wave' | 'wavyHeavy' | 'wavyDouble';
+/**
+ * Text effect animations
+ */
+type TextEffect = 'none' | 'blinkBackground' | 'lights' | 'antsBlack' | 'antsRed' | 'shimmer' | 'sparkle';
+/**
+ * Emphasis mark type
+ */
+type EmphasisMark = 'none' | 'dot' | 'comma' | 'circle' | 'underDot';
+/**
+ * Character-level formatting (`w:rPr`) — the full set of run properties
+ * Word supports: weight, slant, font, size, color, highlight, underline,
+ * strikethrough, vertical position, language, complex-script variants,
+ * spacing/kerning, emphasis marks, and more.
+ *
+ * Most fields mirror their ECMA-376 element names (see §17.3.2). Missing
+ * keys inherit from the run's paragraph style → linked style → document
+ * defaults chain.
+ */
+interface TextFormatting {
+    /** Bold (w:b) */
+    bold?: boolean;
+    /** Bold complex script (w:bCs) */
+    boldCs?: boolean;
+    /** Italic (w:i) */
+    italic?: boolean;
+    /** Italic complex script (w:iCs) */
+    italicCs?: boolean;
+    /** Underline style and color (w:u) */
+    underline?: {
+        style: UnderlineStyle;
+        color?: ColorValue;
+    };
+    /** Strikethrough (w:strike) */
+    strike?: boolean;
+    /** Double strikethrough (w:dstrike) */
+    doubleStrike?: boolean;
+    /** Superscript/subscript (w:vertAlign) */
+    vertAlign?: 'baseline' | 'superscript' | 'subscript';
+    /** Small caps (w:smallCaps) */
+    smallCaps?: boolean;
+    /** All caps (w:caps) */
+    allCaps?: boolean;
+    /** Hidden text (w:vanish) */
+    hidden?: boolean;
+    /** Text color (w:color) */
+    color?: ColorValue;
+    /** Highlight/background color (w:highlight) */
+    highlight?: 'black' | 'blue' | 'cyan' | 'darkBlue' | 'darkCyan' | 'darkGray' | 'darkGreen' | 'darkMagenta' | 'darkRed' | 'darkYellow' | 'green' | 'lightGray' | 'magenta' | 'none' | 'red' | 'white' | 'yellow';
+    /** Character shading (w:shd) */
+    shading?: ShadingProperties;
+    /** Font size in half-points (w:sz) - e.g., 24 = 12pt */
+    fontSize?: number;
+    /** Font size complex script (w:szCs) */
+    fontSizeCs?: number;
+    /** Font family (w:rFonts) */
+    fontFamily?: {
+        ascii?: string;
+        hAnsi?: string;
+        eastAsia?: string;
+        cs?: string;
+        /** Theme font reference */
+        asciiTheme?: 'majorAscii' | 'majorHAnsi' | 'majorEastAsia' | 'majorBidi' | 'minorAscii' | 'minorHAnsi' | 'minorEastAsia' | 'minorBidi';
+        hAnsiTheme?: string;
+        eastAsiaTheme?: string;
+        csTheme?: string;
+    };
+    /** Character spacing in twips (w:spacing) */
+    spacing?: number;
+    /** Raised/lowered text position in half-points (w:position) */
+    position?: number;
+    /** Horizontal text scale percentage (w:w) */
+    scale?: number;
+    /** Kerning threshold in half-points (w:kern) */
+    kerning?: number;
+    /** Text effect animation (w:effect) */
+    effect?: TextEffect;
+    /** Emphasis mark (w:em) */
+    emphasisMark?: EmphasisMark;
+    /** Emboss effect (w:emboss) */
+    emboss?: boolean;
+    /** Imprint/engrave effect (w:imprint) */
+    imprint?: boolean;
+    /** Outline effect (w:outline) */
+    outline?: boolean;
+    /** Shadow effect (w:shadow) */
+    shadow?: boolean;
+    /** Right-to-left text (w:rtl) */
+    rtl?: boolean;
+    /** Complex script formatting (w:cs) */
+    cs?: boolean;
+    /** Character style ID (w:rStyle) */
+    styleId?: string;
+}
+/**
+ * Tab stop alignment
+ */
+type TabStopAlignment = 'left' | 'center' | 'right' | 'decimal' | 'bar' | 'clear' | 'num';
+/**
+ * Tab leader character
+ */
+type TabLeader = 'none' | 'dot' | 'hyphen' | 'underscore' | 'heavy' | 'middleDot';
+/**
+ * Tab stop definition
+ */
+interface TabStop {
+    /** Position in twips from left margin */
+    position: number;
+    /** Alignment at tab stop */
+    alignment: TabStopAlignment;
+    /** Leader character */
+    leader?: TabLeader;
+}
+/**
+ * Line spacing rule
+ */
+type LineSpacingRule = 'auto' | 'exact' | 'atLeast';
+/**
+ * Paragraph alignment/justification
+ */
+type ParagraphAlignment = 'left' | 'center' | 'right' | 'both' | 'distribute' | 'mediumKashida' | 'highKashida' | 'lowKashida' | 'thaiDistribute';
+/**
+ * Per-side flags identifying which `<w:spacing>` attrs were inline (not
+ * inherited from a style chain). Used to suppress style-only spacing on
+ * empty paragraphs per Word's behavior.
+ */
+type SpacingExplicit = {
+    before?: boolean;
+    after?: boolean;
+};
+/**
+ * Paragraph-level formatting (`w:pPr`) — alignment, indentation, spacing
+ * (before/after, line height), pagination flags (keepNext, keepLines,
+ * pageBreakBefore, widowControl), tabs, borders, shading, numbering
+ * reference, style reference, and frame/anchored-text properties.
+ *
+ * Most fields mirror their ECMA-376 element names (see §17.3.1).
+ * Inheritance: direct formatting beats the linked style which beats
+ * document defaults.
+ */
+interface ParagraphFormatting {
+    /** Paragraph alignment (w:jc) */
+    alignment?: ParagraphAlignment;
+    /** Text direction (w:bidi) */
+    bidi?: boolean;
+    /** Spacing before in twips (w:spacing/@w:before) */
+    spaceBefore?: number;
+    /** Spacing after in twips (w:spacing/@w:after) */
+    spaceAfter?: number;
+    /** Line spacing value (w:spacing/@w:line) */
+    lineSpacing?: number;
+    /** Line spacing rule (w:spacing/@w:lineRule) */
+    lineSpacingRule?: LineSpacingRule;
+    /** Auto space before (w:spacing/@w:beforeAutospacing) */
+    beforeAutospacing?: boolean;
+    /** Auto space after (w:spacing/@w:afterAutospacing) */
+    afterAutospacing?: boolean;
+    /**
+     * Per-side flags marking which `<w:spacing>` attrs came from this
+     * paragraph's own pPr (vs inherited). Word collapses style-inherited
+     * spacing on empty paragraphs but honors the explicit values.
+     */
+    spacingExplicit?: SpacingExplicit;
+    /** Left indent in twips (w:ind/@w:left) */
+    indentLeft?: number;
+    /** Right indent in twips (w:ind/@w:right) */
+    indentRight?: number;
+    /** First line indent in twips - positive for indent, negative for hanging (w:ind/@w:firstLine or @w:hanging) */
+    indentFirstLine?: number;
+    /** Whether first line is hanging indent */
+    hangingIndent?: boolean;
+    /** Paragraph borders (w:pBdr) */
+    borders?: {
+        top?: BorderSpec;
+        bottom?: BorderSpec;
+        left?: BorderSpec;
+        right?: BorderSpec;
+        between?: BorderSpec;
+        bar?: BorderSpec;
+    };
+    /** Paragraph shading (w:shd) */
+    shading?: ShadingProperties;
+    /** Custom tab stops (w:tabs) */
+    tabs?: TabStop[];
+    /** Keep with next paragraph (w:keepNext) */
+    keepNext?: boolean;
+    /** Keep lines together (w:keepLines) */
+    keepLines?: boolean;
+    /** Widow/orphan control (w:widowControl) */
+    widowControl?: boolean;
+    /** Page break before (w:pageBreakBefore) */
+    pageBreakBefore?: boolean;
+    /** Contextual spacing — suppress space between paragraphs of the same style (w:contextualSpacing) */
+    contextualSpacing?: boolean;
+    /** Numbering properties (w:numPr) */
+    numPr?: {
+        /** Numbering definition ID (w:numId) */
+        numId?: number;
+        /** List level (0-8) (w:ilvl) */
+        ilvl?: number;
+    };
+    /** Outline level 0-9 (w:outlineLvl) */
+    outlineLevel?: number;
+    /** Paragraph style ID (w:pStyle) */
+    styleId?: string;
+    /** Text frame properties (w:framePr) */
+    frame?: {
+        width?: number;
+        height?: number;
+        hAnchor?: 'text' | 'margin' | 'page';
+        vAnchor?: 'text' | 'margin' | 'page';
+        x?: number;
+        y?: number;
+        xAlign?: 'left' | 'center' | 'right' | 'inside' | 'outside';
+        yAlign?: 'top' | 'center' | 'bottom' | 'inside' | 'outside' | 'inline';
+        wrap?: 'around' | 'auto' | 'none' | 'notBeside' | 'through' | 'tight';
+    };
+    /** Suppress line numbers (w:suppressLineNumbers) */
+    suppressLineNumbers?: boolean;
+    /** Suppress auto hyphens (w:suppressAutoHyphens) */
+    suppressAutoHyphens?: boolean;
+    /** Run properties to apply to all runs (w:rPr) */
+    runProperties?: TextFormatting;
+}
+/**
+ * Table width type
+ */
+type TableWidthType = 'auto' | 'dxa' | 'nil' | 'pct';
+/**
+ * Table measurement (width or height)
+ */
+interface TableMeasurement {
+    /** Value in twips (for dxa) or fifths of a percent (for pct) */
+    value: number;
+    /** Measurement type */
+    type: TableWidthType;
+}
+/**
+ * Table borders
+ */
+interface TableBorders {
+    top?: BorderSpec;
+    bottom?: BorderSpec;
+    left?: BorderSpec;
+    right?: BorderSpec;
+    insideH?: BorderSpec;
+    insideV?: BorderSpec;
+}
+/**
+ * Cell margins
+ */
+interface CellMargins {
+    top?: TableMeasurement;
+    bottom?: TableMeasurement;
+    left?: TableMeasurement;
+    right?: TableMeasurement;
+}
+/**
+ * Table look flags (for table styles)
+ */
+interface TableLook {
+    firstColumn?: boolean;
+    firstRow?: boolean;
+    lastColumn?: boolean;
+    lastRow?: boolean;
+    noHBand?: boolean;
+    noVBand?: boolean;
+}
+/**
+ * Floating table properties
+ */
+interface FloatingTableProperties {
+    /** Horizontal anchor */
+    horzAnchor?: 'margin' | 'page' | 'text';
+    /** Vertical anchor */
+    vertAnchor?: 'margin' | 'page' | 'text';
+    /** Horizontal position */
+    tblpX?: number;
+    tblpXSpec?: 'left' | 'center' | 'right' | 'inside' | 'outside';
+    /** Vertical position */
+    tblpY?: number;
+    tblpYSpec?: 'top' | 'center' | 'bottom' | 'inside' | 'outside' | 'inline';
+    /** Distance from surrounding text */
+    topFromText?: number;
+    bottomFromText?: number;
+    leftFromText?: number;
+    rightFromText?: number;
+}
+/**
+ * Table formatting properties (w:tblPr)
+ */
+interface TableFormatting {
+    /** Table width */
+    width?: TableMeasurement;
+    /** Table justification */
+    justification?: 'left' | 'center' | 'right';
+    /** Cell spacing */
+    cellSpacing?: TableMeasurement;
+    /** Table indent from left margin */
+    indent?: TableMeasurement;
+    /** Table borders */
+    borders?: TableBorders;
+    /** Default cell margins */
+    cellMargins?: CellMargins;
+    /** Table layout */
+    layout?: 'fixed' | 'autofit';
+    /** Table style ID */
+    styleId?: string;
+    /** Table look (conditional formatting flags) */
+    look?: TableLook;
+    /** Shading/background */
+    shading?: ShadingProperties;
+    /** Overlap for floating tables */
+    overlap?: 'never' | 'overlap';
+    /** Floating table properties */
+    floating?: FloatingTableProperties;
+    /** Right to left table */
+    bidi?: boolean;
+}
+/**
+ * Table row formatting properties (w:trPr)
+ */
+interface TableRowFormatting {
+    /** Row height */
+    height?: TableMeasurement;
+    /** Height rule */
+    heightRule?: 'auto' | 'atLeast' | 'exact';
+    /** Header row (repeats on each page) */
+    header?: boolean;
+    /** Allow row to break across pages */
+    cantSplit?: boolean;
+    /** Row justification */
+    justification?: 'left' | 'center' | 'right';
+    /** Hidden row */
+    hidden?: boolean;
+    /** Conditional format style */
+    conditionalFormat?: ConditionalFormatStyle;
+}
+/**
+ * Conditional format style
+ */
+interface ConditionalFormatStyle {
+    /** First row */
+    firstRow?: boolean;
+    /** Last row */
+    lastRow?: boolean;
+    /** First column */
+    firstColumn?: boolean;
+    /** Last column */
+    lastColumn?: boolean;
+    /** Odd horizontal band */
+    oddHBand?: boolean;
+    /** Even horizontal band */
+    evenHBand?: boolean;
+    /** Odd vertical band */
+    oddVBand?: boolean;
+    /** Even vertical band */
+    evenVBand?: boolean;
+    /** Northwest corner */
+    nwCell?: boolean;
+    /** Northeast corner */
+    neCell?: boolean;
+    /** Southwest corner */
+    swCell?: boolean;
+    /** Southeast corner */
+    seCell?: boolean;
+}
+/**
+ * Table cell formatting properties (w:tcPr)
+ */
+interface TableCellFormatting {
+    /** Cell width */
+    width?: TableMeasurement;
+    /** Cell borders */
+    borders?: TableBorders;
+    /** Cell margins (override table default) */
+    margins?: CellMargins;
+    /** Cell shading/background */
+    shading?: ShadingProperties;
+    /** Vertical alignment */
+    verticalAlign?: 'top' | 'center' | 'bottom';
+    /** Text direction */
+    textDirection?: 'lr' | 'lrV' | 'rl' | 'rlV' | 'tb' | 'tbV' | 'tbRl' | 'tbRlV' | 'btLr';
+    /** Grid span (horizontal merge) */
+    gridSpan?: number;
+    /** Vertical merge */
+    vMerge?: 'restart' | 'continue';
+    /** Fit text to cell width */
+    fitText?: boolean;
+    /** Wrap text */
+    noWrap?: boolean;
+    /** Hide cell marker */
+    hideMark?: boolean;
+    /** Conditional format style */
+    conditionalFormat?: ConditionalFormatStyle;
+}
+
+export type { CellMargins as C, EmphasisMark as E, FloatingTableProperties as F, LineSpacingRule as L, ParagraphFormatting as P, SpacingExplicit as S, TextFormatting as T, UnderlineStyle as U, TableFormatting as a, TableRowFormatting as b, TableCellFormatting as c, ParagraphAlignment as d, TabStop as e, TableLook as f, ConditionalFormatStyle as g, TabLeader as h, TabStopAlignment as i, TableBorders as j, TableMeasurement as k, TableWidthType as l, TextEffect as m };