@stll/folio-core 0.0.1-placeholder.0 → 0.1.1

package/dist/docx/tableParser.d.ts

@@ -0,0 +1,202 @@
+import { document_d_exports } from "../types/document.js";
+import { NumberingMap } from "./numberingParser.js";
+import { StyleMap } from "./styleParser.js";
+import { XmlElement } from "./xmlParser.js";
+
+//#region src/docx/tableParser.d.ts
+/**
+ * Parse a table measurement (width, height, etc.)
+ *
+ * @param element - Element with w:w and w:type attributes
+ * @returns Parsed measurement or undefined
+ */
+declare function parseTableMeasurement(element: XmlElement | null): document_d_exports.TableMeasurement | undefined;
+/**
+ * Parse a single border specification
+ *
+ * @param element - Border element (w:top, w:bottom, etc.)
+ * @returns Parsed border or undefined
+ */
+declare function parseBorderSpec(element: XmlElement | null): document_d_exports.BorderSpec | undefined;
+/**
+ * Parse table borders (w:tblBorders or w:tcBorders)
+ *
+ * @param bordersElement - The borders container element
+ * @returns Parsed borders or undefined
+ */
+declare function parseTableBorders(bordersElement: XmlElement | null): document_d_exports.TableBorders | undefined;
+/**
+ * Parse cell margins (w:tblCellMar or w:tcMar)
+ *
+ * @param marginsElement - The margins container element
+ * @returns Parsed margins or undefined
+ */
+declare function parseCellMargins(marginsElement: XmlElement | null): document_d_exports.CellMargins | undefined;
+/**
+ * Parse shading properties (w:shd)
+ *
+ * @param shdElement - The w:shd element
+ * @returns Parsed shading or undefined
+ */
+declare function parseShading(shdElement: XmlElement | null): document_d_exports.ShadingProperties | undefined;
+/**
+ * Parse table look flags (w:tblLook)
+ *
+ * @param lookElement - The w:tblLook element
+ * @returns Parsed table look or undefined
+ */
+declare function parseTableLook(lookElement: XmlElement | null): document_d_exports.TableLook | undefined;
+/**
+ * Parse floating table properties (w:tblpPr)
+ *
+ * @param tblpPrElement - The w:tblpPr element
+ * @returns Parsed floating properties or undefined
+ */
+declare function parseFloatingTableProperties(tblpPrElement: XmlElement | null): document_d_exports.FloatingTableProperties | undefined;
+/**
+ * Parse table properties (w:tblPr)
+ *
+ * @param tblPrElement - The w:tblPr element
+ * @returns Parsed table formatting
+ */
+declare function parseTableProperties(tblPrElement: XmlElement | null): document_d_exports.TableFormatting | undefined;
+/**
+ * Parse table row properties (w:trPr)
+ *
+ * @param trPrElement - The w:trPr element
+ * @returns Parsed row formatting
+ */
+declare function parseTableRowProperties(trPrElement: XmlElement | null): document_d_exports.TableRowFormatting | undefined;
+/**
+ * Parse conditional format style (for table style conditional formatting)
+ *
+ * @param cnfElement - The w:cnfStyle element
+ * @returns Parsed conditional format or undefined
+ */
+declare function parseConditionalFormatStyle(cnfElement: XmlElement | null): document_d_exports.ConditionalFormatStyle | undefined;
+/**
+ * Parse table cell properties (w:tcPr)
+ *
+ * @param tcPrElement - The w:tcPr element
+ * @returns Parsed cell formatting
+ */
+declare function parseTableCellProperties(tcPrElement: XmlElement | null): document_d_exports.TableCellFormatting | undefined;
+/**
+ * Parse a table cell (w:tc)
+ *
+ * @param tcElement - The w:tc element
+ * @param styles - Style definitions
+ * @param theme - Theme for color/font resolution
+ * @param numbering - Numbering definitions for lists
+ * @param rels - Relationships for hyperlinks
+ * @param media - Media files for images
+ * @returns Parsed table cell
+ */
+declare function parseTableCell(tcElement: XmlElement, styles: StyleMap | null, theme: document_d_exports.Theme | null, numbering: NumberingMap | null, rels: document_d_exports.RelationshipMap | null, media: Map<string, document_d_exports.MediaFile> | null, options?: {
+  inHeaderFooter?: boolean;
+  rootXmlns?: Record<string, string>;
+}): document_d_exports.TableCell;
+/**
+ * Parse a table row (w:tr)
+ *
+ * @param trElement - The w:tr element
+ * @param styles - Style definitions
+ * @param theme - Theme for color/font resolution
+ * @param numbering - Numbering definitions for lists
+ * @param rels - Relationships for hyperlinks
+ * @param media - Media files for images
+ * @returns Parsed table row
+ */
+declare function parseTableRow(trElement: XmlElement, styles: StyleMap | null, theme: document_d_exports.Theme | null, numbering: NumberingMap | null, rels: document_d_exports.RelationshipMap | null, media: Map<string, document_d_exports.MediaFile> | null, options?: {
+  inHeaderFooter?: boolean;
+  rootXmlns?: Record<string, string>;
+}): document_d_exports.TableRow;
+/**
+ * Parse table grid (w:tblGrid) for column widths
+ *
+ * @param tblGridElement - The w:tblGrid element
+ * @returns Array of column widths in twips
+ */
+declare function parseTableGrid(tblGridElement: XmlElement | null): number[] | undefined;
+/**
+ * Parse a table element (w:tbl)
+ *
+ * @param tblElement - The w:tbl element
+ * @param styles - Style definitions
+ * @param theme - Theme for color/font resolution
+ * @param numbering - Numbering definitions for lists
+ * @param rels - Relationships for hyperlinks
+ * @param media - Media files for images
+ * @returns Parsed table
+ */
+declare function parseTable(tblElement: XmlElement, styles: StyleMap | null, theme: document_d_exports.Theme | null, numbering: NumberingMap | null, rels: document_d_exports.RelationshipMap | null, media: Map<string, document_d_exports.MediaFile> | null, options?: {
+  inHeaderFooter?: boolean;
+  rootXmlns?: Record<string, string>;
+}): document_d_exports.Table;
+/**
+ * Get the number of columns in a table
+ *
+ * Uses the table grid if available, otherwise counts cells in first row.
+ *
+ * @param table - The table to measure
+ * @returns Number of columns
+ */
+declare function getTableColumnCount(table: document_d_exports.Table): number;
+/**
+ * Get the number of rows in a table
+ *
+ * @param table - The table to measure
+ * @returns Number of rows
+ */
+declare function getTableRowCount(table: document_d_exports.Table): number;
+/**
+ * Check if a cell is part of a vertical merge
+ *
+ * @param cell - The cell to check
+ * @returns true if cell continues a vertical merge
+ */
+declare function isCellMergeContinuation(cell: document_d_exports.TableCell): boolean;
+/**
+ * Check if a cell starts a vertical merge
+ *
+ * @param cell - The cell to check
+ * @returns true if cell starts a vertical merge
+ */
+declare function isCellMergeStart(cell: document_d_exports.TableCell): boolean;
+/**
+ * Check if a cell spans multiple columns
+ *
+ * @param cell - The cell to check
+ * @returns true if cell spans multiple columns
+ */
+declare function isCellHorizontallyMerged(cell: document_d_exports.TableCell): boolean;
+/**
+ * Get the plain text content of a table
+ *
+ * @param table - The table to extract text from
+ * @returns Plain text content
+ */
+declare function getTableText(table: document_d_exports.Table): string;
+/**
+ * Check if table has header row
+ *
+ * @param table - The table to check
+ * @returns true if first row is marked as header
+ */
+declare function hasHeaderRow(table: document_d_exports.Table): boolean;
+/**
+ * Get all header rows from a table
+ *
+ * @param table - The table to search
+ * @returns Array of header rows
+ */
+declare function getHeaderRows(table: document_d_exports.Table): document_d_exports.TableRow[];
+/**
+ * Check if table is a floating table
+ *
+ * @param table - The table to check
+ * @returns true if table has floating properties
+ */
+declare function isFloatingTable(table: document_d_exports.Table): boolean;
+//#endregion
+export { getHeaderRows, getTableColumnCount, getTableRowCount, getTableText, hasHeaderRow, isCellHorizontallyMerged, isCellMergeContinuation, isCellMergeStart, isFloatingTable, parseBorderSpec, parseCellMargins, parseConditionalFormatStyle, parseFloatingTableProperties, parseShading, parseTable, parseTableBorders, parseTableCell, parseTableCellProperties, parseTableGrid, parseTableLook, parseTableMeasurement, parseTableProperties, parseTableRow, parseTableRowProperties };