@silurus/ooxml 0.55.0 → 0.56.0

package/dist/types/docx.d.ts

@@ -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,6 +137,19 @@ export declare type DocRun = {
     fontSize: number;
 };
 
+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;
+}
+
 declare interface DocTable {
     colWidths: number[];
     rows: DocTableRow[];
@@ -141,6 +160,22 @@ 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 {
@@ -150,7 +185,13 @@ declare interface DocTableCell {
     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. */
@@ -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. */

package/dist/types/index.d.ts

@@ -705,6 +705,12 @@ 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;
 }
 
 declare interface DocRevision {
@@ -734,6 +740,19 @@ declare type DocRun = {
     fontSize: number;
 };
 
+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;
+}
+
 declare interface DocTable {
     colWidths: number[];
     rows: DocTableRow[];
@@ -744,6 +763,22 @@ 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 {
@@ -753,7 +788,13 @@ declare interface DocTableCell {
     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. */
@@ -843,6 +884,11 @@ 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;
 }
 
 declare interface DocxTextRun {
@@ -871,6 +917,27 @@ 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. */
@@ -2120,6 +2187,9 @@ declare interface ShapeInfo {
 declare interface ShapeParagraph {
     /** `<a:pPr@algn>` — `l` (default) | `ctr` | `r` | `just` | `dist`. */
     align: string;
+    /** `<a:pPr@rtl>` — whether the paragraph reads right-to-left
+     *  (ECMA-376 §21.1.2.2.7). Omitted (undefined) when false. */
+    rtl?: boolean;
     runs: ShapeTextRun[];
 }
 
@@ -2427,6 +2497,8 @@ declare interface TableElement {
     /** Column widths in EMU */
     cols: number[];
     rows: TableRow[];
+    /** `<a:tblPr rtl="1">` (ECMA-376 §21.1.3.13): right-to-left table — column 0 at the right edge. */
+    rtl?: boolean;
 }
 
 declare interface TableInfo {
@@ -2476,7 +2548,21 @@ declare interface TabStop_2 {
     leader: 'none' | 'dot' | 'hyphen' | 'underscore' | 'heavy' | 'middleDot';
 }
 
-declare interface TextBody {
+/**
+ * PPTX text body. Extends the shared core `TextBody` with PPTX-only bodyPr
+ * fields that the pptx parser surfaces but the shared core model does not yet
+ * carry.
+ */
+declare interface TextBody extends TextBody_2 {
+    /**
+     * `<a:bodyPr rtlCol>` (ECMA-376 §21.1.2.1.1) — when true the columns of a
+     * multi-column text body are laid out right-to-left. Defaults to false;
+     * omitted from JSON when false. Only meaningful when `numCol > 1`.
+     */
+    rtlCol?: boolean;
+}
+
+declare interface TextBody_2 {
     /** Vertical anchor: "t" | "ctr" | "b" */
     verticalAnchor: string;
     paragraphs: Paragraph[];
@@ -2646,6 +2732,10 @@ declare interface Worksheet {
      *  `<sheetView showGridLines>`). Mirrors the Excel "View → Gridlines"
      *  checkbox. Defaults to true. */
     showGridlines?: boolean;
+    /** Whether the sheet grid is laid out right-to-left, mirroring the entire
+     *  grid so column A sits on the right (ECMA-376 §18.3.1.87
+     *  `<sheetView rightToLeft>`). Defaults to false. */
+    rightToLeft?: boolean;
     /** Sheet tab color (ECMA-376 §18.3.1.79). */
     tabColor?: string | null;
     /** AutoFilter header range (ECMA-376 §18.3.1.2). */
@@ -2813,6 +2903,40 @@ declare class XlsxViewer {
     /** The loaded workbook, or throws if {@link load} has not completed. */
     private get workbook();
     showSheet(index: number): Promise<void>;
+    /** True when the current sheet's grid is laid out right-to-left. */
+    private get isRtl();
+    /** Maximum horizontal scroll offset the native scroll host allows (≥ 0). */
+    private get maxScrollLeft();
+    /**
+     * The logical horizontal scroll position used to find the start-of-sheet
+     * (col A) edge, in *scaled* CSS pixels — the same unit as
+     * `scrollHost.scrollLeft`. The renderer always lays the grid out LTR and then
+     * mirrors it (ECMA-376 §18.3.1.87), so the viewer must hand it a position
+     * where 0 = the START of the sheet (col A) and increasing values reveal later
+     * columns.
+     *
+     * For LTR that is exactly the native `scrollLeft`. For RTL the sheet starts at
+     * the RIGHT, so the native scrollbar runs the opposite way: thumb fully right
+     * (`scrollLeft = maxScrollLeft`) is the start, thumb left is the far columns.
+     * Inverting here makes wheel/trackpad follow the finger and aligns the
+     * thumb↔page mapping with Excel, without depending on browser-specific RTL
+     * `scrollLeft` sign conventions.
+     */
+    private get effectiveScrollLeft();
+    /**
+     * Map between the logical-LTR x used by all the cell-geometry math and the
+     * on-screen (canvasArea CSS-pixel) x, applying the RTL mirror (ECMA-376
+     * §18.3.1.87) via the same {@link rtlMirrorX} the renderer uses. For LTR this
+     * is the identity. The mirror is an involution, so this one method serves
+     * both cell→px (overlay draw, `w` = cell width) and px→cell (pointer
+     * hit-testing, `w` = 0 for a point) — guaranteeing the overlay sits exactly
+     * where the cell is drawn and a click resolves to that same cell at every
+     * scroll offset. `canvasArea.clientWidth` equals the renderer's `canvasW`.
+     */
+    private screenX;
+    /** Park the scrollbar at the sheet's natural start: scrollLeft=0 for LTR,
+     *  the right end for RTL (so col A shows first). */
+    private resetHorizontalScroll;
     /** 0-based index of the currently displayed sheet. */
     get sheetIndex(): number;
     /** Total number of sheets in the loaded workbook. */

package/dist/types/pptx.d.ts

@@ -1034,6 +1034,8 @@ declare interface TableElement {
     /** Column widths in EMU */
     cols: number[];
     rows: TableRow[];
+    /** `<a:tblPr rtl="1">` (ECMA-376 §21.1.3.13): right-to-left table — column 0 at the right edge. */
+    rtl?: boolean;
 }
 
 declare interface TableRow {
@@ -1049,7 +1051,21 @@ declare interface TabStop {
     algn: string;
 }
 
-export declare interface TextBody {
+/**
+ * PPTX text body. Extends the shared core `TextBody` with PPTX-only bodyPr
+ * fields that the pptx parser surfaces but the shared core model does not yet
+ * carry.
+ */
+export declare interface TextBody extends TextBody_2 {
+    /**
+     * `<a:bodyPr rtlCol>` (ECMA-376 §21.1.2.1.1) — when true the columns of a
+     * multi-column text body are laid out right-to-left. Defaults to false;
+     * omitted from JSON when false. Only meaningful when `numCol > 1`.
+     */
+    rtlCol?: boolean;
+}
+
+declare interface TextBody_2 {
     /** Vertical anchor: "t" | "ctr" | "b" */
     verticalAnchor: string;
     paragraphs: Paragraph[];

package/dist/types/xlsx.d.ts

@@ -814,6 +814,9 @@ declare interface ShapeInfo {
 declare interface ShapeParagraph {
     /** `<a:pPr@algn>` — `l` (default) | `ctr` | `r` | `just` | `dist`. */
     align: string;
+    /** `<a:pPr@rtl>` — whether the paragraph reads right-to-left
+     *  (ECMA-376 §21.1.2.2.7). Omitted (undefined) when false. */
+    rtl?: boolean;
     runs: ShapeTextRun[];
 }
 
@@ -1009,6 +1012,10 @@ export declare interface Worksheet {
      *  `<sheetView showGridLines>`). Mirrors the Excel "View → Gridlines"
      *  checkbox. Defaults to true. */
     showGridlines?: boolean;
+    /** Whether the sheet grid is laid out right-to-left, mirroring the entire
+     *  grid so column A sits on the right (ECMA-376 §18.3.1.87
+     *  `<sheetView rightToLeft>`). Defaults to false. */
+    rightToLeft?: boolean;
     /** Sheet tab color (ECMA-376 §18.3.1.79). */
     tabColor?: string | null;
     /** AutoFilter header range (ECMA-376 §18.3.1.2). */
@@ -1144,6 +1151,40 @@ export declare class XlsxViewer {
     /** The loaded workbook, or throws if {@link load} has not completed. */
     private get workbook();
     showSheet(index: number): Promise<void>;
+    /** True when the current sheet's grid is laid out right-to-left. */
+    private get isRtl();
+    /** Maximum horizontal scroll offset the native scroll host allows (≥ 0). */
+    private get maxScrollLeft();
+    /**
+     * The logical horizontal scroll position used to find the start-of-sheet
+     * (col A) edge, in *scaled* CSS pixels — the same unit as
+     * `scrollHost.scrollLeft`. The renderer always lays the grid out LTR and then
+     * mirrors it (ECMA-376 §18.3.1.87), so the viewer must hand it a position
+     * where 0 = the START of the sheet (col A) and increasing values reveal later
+     * columns.
+     *
+     * For LTR that is exactly the native `scrollLeft`. For RTL the sheet starts at
+     * the RIGHT, so the native scrollbar runs the opposite way: thumb fully right
+     * (`scrollLeft = maxScrollLeft`) is the start, thumb left is the far columns.
+     * Inverting here makes wheel/trackpad follow the finger and aligns the
+     * thumb↔page mapping with Excel, without depending on browser-specific RTL
+     * `scrollLeft` sign conventions.
+     */
+    private get effectiveScrollLeft();
+    /**
+     * Map between the logical-LTR x used by all the cell-geometry math and the
+     * on-screen (canvasArea CSS-pixel) x, applying the RTL mirror (ECMA-376
+     * §18.3.1.87) via the same {@link rtlMirrorX} the renderer uses. For LTR this
+     * is the identity. The mirror is an involution, so this one method serves
+     * both cell→px (overlay draw, `w` = cell width) and px→cell (pointer
+     * hit-testing, `w` = 0 for a point) — guaranteeing the overlay sits exactly
+     * where the cell is drawn and a click resolves to that same cell at every
+     * scroll offset. `canvasArea.clientWidth` equals the renderer's `canvasW`.
+     */
+    private screenX;
+    /** Park the scrollbar at the sheet's natural start: scrollLeft=0 for LTR,
+     *  the right end for RTL (so col A shows first). */
+    private resetHorizontalScroll;
     /** 0-based index of the currently displayed sheet. */
     get sheetIndex(): number;
     /** Total number of sheets in the loaded workbook. */