@silurus/ooxml 0.55.0 → 0.57.0

package/dist/types/docx.d.ts

@@ -32,13 +32,13 @@ export declare type BodyElement = {
     parity?: 'odd' | 'even';
 };
 
-declare interface BorderSpec {
+export declare interface BorderSpec {
     width: number;
     color: string | null;
     style: string;
 }
 
-declare interface CellBorders {
+export declare interface CellBorders {
     top: BorderSpec | null;
     bottom: BorderSpec | null;
     left: BorderSpec | null;
@@ -46,7 +46,7 @@ declare interface CellBorders {
 }
 
 /** ECMA-376 §17.4.7: a table cell may contain paragraphs AND nested tables. */
-declare type CellElement = {
+export declare type CellElement = {
     type: 'paragraph';
 } & DocParagraph | {
     type: 'table';
@@ -102,6 +102,12 @@ export declare interface DocParagraph {
     /** Default font family resolved from the style chain. Used to size empty
      *  paragraphs (no runs) with the intended font's line metrics. */
     defaultFontFamily?: string | null;
+    /**
+     * ECMA-376 §17.3.1.6 `<w:bidi>` — right-to-left paragraph. `true` = RTL,
+     * `false` = explicitly LTR, absent = unspecified (inherit). Phase 0 of RTL
+     * support: recorded only; alignment/column-order resolution is deferred.
+     */
+    bidi?: boolean;
 }
 
 export declare interface DocRevision {
@@ -131,7 +137,20 @@ export declare type DocRun = {
     fontSize: number;
 };
 
-declare interface DocTable {
+export declare interface DocSettings {
+    /** §17.15.1.58 `w:kinsoku` — East-Asian line-breaking toggle. `undefined`
+     *  means the element is absent; the spec default is ON (treated as `true`). */
+    kinsoku?: boolean;
+    /** §17.15.1.60 `w:noLineBreaksBefore@w:val` — custom set of characters that
+     *  cannot begin a line (行頭禁則). When present it REPLACES the application
+     *  default set. Word's per-`w:lang` sets are merged into one string. */
+    noLineBreaksBefore?: string;
+    /** §17.15.1.59 `w:noLineBreaksAfter@w:val` — custom set of characters that
+     *  cannot end a line (行末禁則). Replaces the default when present. */
+    noLineBreaksAfter?: string;
+}
+
+export declare interface DocTable {
     colWidths: number[];
     rows: DocTableRow[];
     borders: TableBorders;
@@ -141,16 +160,38 @@ declare interface DocTable {
     cellMarginRight: number;
     /** table horizontal alignment on the page: 'left' | 'center' | 'right'. */
     jc: string;
+    /** ECMA-376 §17.4.52 `<w:tblLayout w:type>` — 'fixed' | 'autofit'. Absent
+     *  (undefined) ⇒ spec default 'autofit': columns are sized by the per-column
+     *  max preferred width (cell `widthPt`), tblGrid only as fallback. 'fixed'
+     *  uses tblGrid widths verbatim (scaled to fit). */
+    layout?: string;
+    /** ECMA-376 §17.4.63 `<w:tblW>` preferred table width (type="dxa"), pt. */
+    widthPt?: number;
+    /** `<w:tblW>` type="pct": 50ths of a percent of available content width. */
+    widthPct?: number;
+    /**
+     * ECMA-376 §17.4.1 `<w:bidiVisual>` — render columns in right-to-left
+     * (visual) order. `true` = RTL columns, `false` = explicitly LTR, absent =
+     * unspecified. Phase 0 of RTL support: recorded only; column-order
+     * resolution is deferred.
+     */
+    bidiVisual?: boolean;
 }
 
-declare interface DocTableCell {
+export declare interface DocTableCell {
     content: CellElement[];
     colSpan: number;
     vMerge: boolean | null;
     borders: CellBorders;
     background: string | null;
     vAlign: 'top' | 'center' | 'bottom';
+    /** ECMA-376 §17.4.71 `<w:tcW>` preferred cell width (type="dxa"), pt. Drives
+     *  autofit column sizing: each grid column's width is the max `widthPt` over
+     *  the cells anchored in it. */
     widthPt: number | null;
+    /** `<w:tcW>` type="pct": 50ths of a percent of available content width.
+     *  Resolved against the available width at render time. */
+    widthPct?: number;
     /** Per-cell margins (pt) from `<w:tcPr><w:tcMar>` (ECMA-376 §17.4.42). Each
      *  edge overrides the table-level `cellMargin*` default when set; null/absent
      *  = inherit the table default. */
@@ -160,7 +201,7 @@ declare interface DocTableCell {
     marginRight?: number | null;
 }
 
-declare interface DocTableRow {
+export declare interface DocTableRow {
     cells: DocTableCell[];
     rowHeight: number | null;
     /** ECMA-376 §17.4.80 hRule. "auto" (default) = informational; "atLeast" =
@@ -216,6 +257,11 @@ export declare interface DocxDocumentModel {
     /** ECMA-376 §17.11.4 — `word/endnotes.xml` (id + text). Same shape as
      *  `footnotes`. */
     endnotes?: DocNote[];
+    /** ECMA-376 §17.15.1.* — document-wide compatibility / typography settings
+     *  from `word/settings.xml`. Currently carries the Japanese line-breaking
+     *  (kinsoku) configuration. Absent when settings.xml has no relevant
+     *  elements (the renderer then uses spec defaults: kinsoku ON). */
+    settings?: DocSettings;
 }
 
 export declare interface DocxTextRun {
@@ -244,6 +290,27 @@ export declare interface DocxTextRun {
      *  underline and deletions with an author-coloured strikethrough so
      *  tracked changes appear inline. */
     revision?: RunRevision;
+    /** ECMA-376 §17.3.2.30 `<w:rtl>` — complex-script / right-to-left run.
+     *  `true` = RTL, `false` = explicitly LTR, absent = unspecified.
+     *  Phase 0: recorded only; glyph-order resolution is deferred. */
+    rtl?: boolean;
+    /** ECMA-376 §17.3.2.7 `<w:cs/>` — complex-script run toggle: cs formatting
+     *  applies to ALL characters of the run (§17.3.2.26). Distinct from
+     *  `rFonts@cs` (`fontFamilyCs`), which is only a font slot. */
+    cs?: boolean;
+    /** ECMA-376 §17.3.2.26 `<w:rFonts w:cs>` — complex-script typeface
+     *  (theme references resolved to a literal family). */
+    fontFamilyCs?: string;
+    /** ECMA-376 §17.3.2.39 `<w:szCs>` — complex-script font size in pt
+     *  (same units as `fontSize`). */
+    fontSizeCs?: number;
+    /** ECMA-376 §17.3.2.3 `<w:bCs>` — complex-script bold toggle. */
+    boldCs?: boolean;
+    /** ECMA-376 §17.3.2.17 `<w:iCs>` — complex-script italic toggle. */
+    italicCs?: boolean;
+    /** ECMA-376 §17.3.2.20 `<w:lang w:bidi>` — complex-script (RTL) language tag,
+     *  lower-cased (e.g. "ar-sa", "ae-ar"). Drives Word's AN digit ordering. */
+    langBidi?: string;
 }
 
 /** Information about a rendered text segment for building a transparent selection overlay. */
@@ -305,7 +372,7 @@ export declare interface DocxViewerOptions extends RenderPageOptions, LoadOption
     onError?: (err: Error) => void;
 }
 
-declare interface FieldRun {
+export declare interface FieldRun {
     /** "page" | "numPages" | "other" */
     fieldType: string;
     instruction: string;
@@ -325,18 +392,18 @@ declare interface FieldRun {
     highlight?: string | null;
 }
 
-declare interface GradientStop {
+export declare interface GradientStop {
     /** 0.0–1.0 */
     position: number;
     /** hex 6-char */
     color: string;
 }
 
-declare interface HeaderFooter {
+export declare interface HeaderFooter {
     body: BodyElement[];
 }
 
-declare interface HeadersFooters {
+export declare interface HeadersFooters {
     default: HeaderFooter | null;
     first: HeaderFooter | null;
     even: HeaderFooter | null;
@@ -386,7 +453,7 @@ export declare interface ImageRun {
     wrapSide?: string;
 }
 
-declare interface LineSpacing {
+export declare interface LineSpacing {
     value: number;
     rule: 'auto' | 'exact' | 'atLeast';
     /** True when `w:spacing/@w:line` was set on the paragraph's own pPr or on a
@@ -581,7 +648,7 @@ declare interface MathSvg {
     descentEm: number;
 }
 
-declare interface NumberingInfo {
+export declare interface NumberingInfo {
     numId: number;
     level: number;
     format: string;
@@ -590,7 +657,7 @@ declare interface NumberingInfo {
     tab: number;
 }
 
-declare interface ParaBorderEdge {
+export declare interface ParaBorderEdge {
     style: string;
     color: string | null;
     /** pt (sz / 8) */
@@ -599,7 +666,7 @@ declare interface ParaBorderEdge {
     space: number;
 }
 
-declare interface ParagraphBorders {
+export declare interface ParagraphBorders {
     top: ParaBorderEdge | null;
     bottom: ParaBorderEdge | null;
     left: ParaBorderEdge | null;
@@ -607,7 +674,7 @@ declare interface ParagraphBorders {
     between: ParaBorderEdge | null;
 }
 
-declare type PathCmd = {
+export declare type PathCmd = {
     cmd: 'moveTo';
     x: number;
     y: number;
@@ -654,7 +721,7 @@ export declare interface RenderPageOptions {
     showTrackChanges?: boolean;
 }
 
-declare interface RubyAnnotation {
+export declare interface RubyAnnotation {
     text: string;
     /** Annotation font size in pt. Word stores this as half-points in `<w:hps>`. */
     fontSizePt: number;
@@ -698,7 +765,7 @@ declare type ShapeFill = {
     gradType: string;
 };
 
-declare interface ShapeRun {
+export declare interface ShapeRun {
     widthPt: number;
     heightPt: number;
     /** X offset in pt */
@@ -765,7 +832,7 @@ declare interface ShapeRun {
     textInsetB?: number;
 }
 
-declare interface ShapeText {
+export declare interface ShapeText {
     text: string;
     fontSizePt: number;
     color?: string | null;
@@ -775,7 +842,7 @@ declare interface ShapeText {
     alignment: string;
 }
 
-declare interface TableBorders {
+export declare interface TableBorders {
     top: BorderSpec | null;
     bottom: BorderSpec | null;
     left: BorderSpec | null;
@@ -784,7 +851,7 @@ declare interface TableBorders {
     insideV: BorderSpec | null;
 }
 
-declare interface TabStop {
+export declare interface TabStop {
     /** tab stop position in pt (from the left of paragraph content area) */
     pos: number;
     alignment: 'left' | 'center' | 'right' | 'decimal' | 'bar' | 'clear';