@beyondwork/docx-react-component 1.0.17 → 1.0.19

package/src/io/ooxml/parse-main-document.ts

@@ -1,4 +1,5 @@
 import type {
+  BorderSpec,
   TextMark,
   ParagraphBorders,
   ParagraphShading,
@@ -6,6 +7,16 @@ import type {
   ParagraphIndentation,
   TabStop,
   TableLook,
+  SectionProperties,
+  PageSize,
+  PageMargins,
+  ColumnProperties,
+  PageNumbering,
+  HeaderFooterReference,
+  HeaderFooterVariant,
+  SectionDocumentGrid,
+  SectionLineNumbering,
+  SectionPageBorders,
 } from "../../model/canonical-document.ts";
 import type { OpcRelationship } from "./part-manifest.ts";
 import {
@@ -18,6 +29,7 @@ import { parseShapeXml, parseVmlXml } from "./parse-shapes.ts";
 
 export interface ParsedMainDocument {
   blocks: ParsedBlockNode[];
+  finalSectionProperties?: SectionProperties;
 }
 
 export type ParsedBlockNode =
@@ -26,8 +38,15 @@ export type ParsedBlockNode =
   | ParsedSdtNode
   | ParsedCustomXmlNode
   | ParsedAltChunkNode
+  | ParsedSectionBreakNode
   | ParsedOpaqueBlockNode;
 
+export interface ParsedSectionBreakNode {
+  type: "section_break";
+  sectionPropertiesXml: string;
+  sectionProperties: SectionProperties;
+}
+
 export interface ParsedParagraphNode {
   type: "paragraph";
   styleId?: string;
@@ -49,6 +68,8 @@ export interface ParsedParagraphNode {
   bidi?: boolean;
   suppressLineNumbers?: boolean;
   cnfStyle?: string;
+  sectionProperties?: SectionProperties;
+  sectionPropertiesXml?: string;
   children: ParsedInlineNode[];
   rawXml: string;
 }
@@ -152,6 +173,7 @@ export interface ParsedShapeInlineNode {
   type: "shape";
   text?: string;
   geometry?: string;
+  isTextBox?: boolean;
   rawXml: string;
 }
 
@@ -195,6 +217,23 @@ export interface ParsedOpaqueBlockNode {
   rawXml: string;
 }
 
+export interface ParsedSdtCheckboxState {
+  checked: boolean;
+  checkedChar?: string;
+  uncheckedChar?: string;
+}
+
+export interface ParsedSdtDatePickerState {
+  fullDate?: string;
+  dateFormat?: string;
+  lid?: string;
+}
+
+export interface ParsedSdtDropdownListItem {
+  displayText?: string;
+  value: string;
+}
+
 export interface ParsedSdtNode {
   type: "sdt";
   properties: {
@@ -203,6 +242,11 @@ export interface ParsedSdtNode {
     tag?: string;
     lock?: string;
     propertiesXml?: string;
+    checkbox?: ParsedSdtCheckboxState;
+    datePicker?: ParsedSdtDatePickerState;
+    dropdownList?: ParsedSdtDropdownListItem[];
+    comboBox?: ParsedSdtDropdownListItem[];
+    showingPlcHdr?: boolean;
   };
   children: ParsedBlockNode[];
   rawXml: string;
@@ -290,11 +334,24 @@ export function parseMainDocumentXml(
   const bodyElement = findChildElement(documentElement, "body");
   const relationshipMap = new Map(relationships.map((relationship) => [relationship.id, relationship]));
 
-  return {
-    blocks: bodyElement.children
-      .filter((node): node is XmlElementNode => node.type === "element")
-      .map((node) => parseBodyChild(node, xml, relationshipMap, relationships, mediaParts, sourcePartPath)),
-  };
+  const allBlocks = bodyElement.children
+    .filter((node): node is XmlElementNode => node.type === "element")
+    .map((node) => parseBodyChild(node, xml, relationshipMap, relationships, mediaParts, sourcePartPath));
+
+  // The last body-level sectPr is the final section properties (not an intermediate section break).
+  // Extract it from the blocks list and store it separately.
+  let finalSectionProperties: SectionProperties | undefined;
+  const blocks: ParsedBlockNode[] = [];
+  for (let i = 0; i < allBlocks.length; i++) {
+    const block = allBlocks[i];
+    if (block.type === "section_break" && i === allBlocks.length - 1) {
+      finalSectionProperties = block.sectionProperties;
+    } else {
+      blocks.push(block);
+    }
+  }
+
+  return { blocks, finalSectionProperties };
 }
 
 function parseBodyChild(
@@ -340,6 +397,10 @@ function parseBodyChild(
     return parseAltChunkElement(node, sourceXml);
   }
 
+  if (nodeType === "sectPr") {
+    return parseSectionBreakElement(node, sourceXml);
+  }
+
   if (nodeType !== "p") {
     return {
       type: "opaque_block",
@@ -363,6 +424,8 @@ function parseBodyChild(
   let bidi: ParsedParagraphNode["bidi"];
   let suppressLineNumbers: ParsedParagraphNode["suppressLineNumbers"];
   let cnfStyle: ParsedParagraphNode["cnfStyle"];
+  let sectionProperties: SectionProperties | undefined;
+  let sectionPropertiesXml: string | undefined;
   let paragraphSupported = true;
   const children: ParsedInlineNode[] = [];
 
@@ -389,6 +452,8 @@ function parseBodyChild(
         bidi = readOnOffParagraphProperty(child, "bidi");
         suppressLineNumbers = readOnOffParagraphProperty(child, "suppressLineNumbers");
         cnfStyle = readParagraphCnfStyle(child);
+        sectionProperties = readSectionPropertiesFromPPr(child);
+        sectionPropertiesXml = readSectionPropertiesXmlFromPPr(child, sourceXml);
         paragraphSupported = paragraphSupported && supportsParagraphProperties(child);
         break;
       case "r":
@@ -452,6 +517,8 @@ function parseBodyChild(
     ...(bidi ? { bidi } : {}),
     ...(suppressLineNumbers ? { suppressLineNumbers } : {}),
     ...(cnfStyle ? { cnfStyle } : {}),
+    ...(sectionProperties ? { sectionProperties } : {}),
+    ...(sectionPropertiesXml ? { sectionPropertiesXml } : {}),
     children,
     rawXml: sourceXml.slice(node.start, node.end),
   };
@@ -692,7 +759,68 @@ function readSdtProperties(
       properties.lock = readOptionalAttribute(child, "val");
       continue;
     }
-    if (!properties.sdtType && name !== "id" && name !== "placeholder" && name !== "showingPlcHdr") {
+    if (name === "showingPlcHdr") {
+      const val = readOptionalAttribute(child, "val");
+      properties.showingPlcHdr = val !== "false" && val !== "0";
+      continue;
+    }
+
+    // Checkbox (w14:checkbox)
+    if (name === "checkbox") {
+      properties.sdtType = "checkbox";
+      const checkedNode = findFirstDescendant(child, "checked");
+      const checkedVal = checkedNode ? (readOptionalAttribute(checkedNode, "val") ?? "0") : "0";
+      const checkedCharNode = findFirstDescendant(child, "checkedState");
+      const uncheckedCharNode = findFirstDescendant(child, "uncheckedState");
+      properties.checkbox = {
+        checked: checkedVal === "1" || checkedVal === "true",
+        ...(checkedCharNode ? { checkedChar: readOptionalAttribute(checkedCharNode, "val") } : {}),
+        ...(uncheckedCharNode ? { uncheckedChar: readOptionalAttribute(uncheckedCharNode, "val") } : {}),
+      };
+      continue;
+    }
+
+    // Date picker
+    if (name === "date") {
+      properties.sdtType = "date";
+      const fullDate = readOptionalAttribute(child, "fullDate");
+      const dateFormatNode = findFirstChild(child, "dateFormat");
+      const lidNode = findFirstChild(child, "lid");
+      properties.datePicker = {
+        ...(fullDate ? { fullDate } : {}),
+        ...(dateFormatNode ? { dateFormat: readOptionalAttribute(dateFormatNode, "val") } : {}),
+        ...(lidNode ? { lid: readOptionalAttribute(lidNode, "val") } : {}),
+      };
+      continue;
+    }
+
+    // Dropdown list
+    if (name === "dropDownList") {
+      properties.sdtType = "dropDownList";
+      properties.dropdownList = readSdtListItems(child);
+      continue;
+    }
+
+    // Combo box
+    if (name === "comboBox") {
+      properties.sdtType = "comboBox";
+      properties.comboBox = readSdtListItems(child);
+      continue;
+    }
+
+    // Plain text
+    if (name === "text") {
+      properties.sdtType = "plainText";
+      continue;
+    }
+
+    // Rich text (richText element is the default, but if explicitly present, tag it)
+    if (name === "richText") {
+      properties.sdtType = "richText";
+      continue;
+    }
+
+    if (!properties.sdtType && name !== "id" && name !== "placeholder" && name !== "showingPlcHdr" && name !== "rPr") {
       properties.sdtType = name;
     }
   }
@@ -700,6 +828,34 @@ function readSdtProperties(
   return properties;
 }
 
+function readSdtListItems(node: XmlElementNode): ParsedSdtDropdownListItem[] {
+  const items: ParsedSdtDropdownListItem[] = [];
+  for (const child of node.children) {
+    if (child.type !== "element" || localName(child.name) !== "listItem") continue;
+    const value = readOptionalAttribute(child, "value") ?? "";
+    const displayText = readOptionalAttribute(child, "displayText");
+    items.push({ value, ...(displayText ? { displayText } : {}) });
+  }
+  return items;
+}
+
+function findFirstChild(node: XmlElementNode, local: string): XmlElementNode | undefined {
+  for (const child of node.children) {
+    if (child.type === "element" && localName(child.name) === local) return child;
+  }
+  return undefined;
+}
+
+function findFirstDescendant(node: XmlElementNode, local: string): XmlElementNode | undefined {
+  for (const child of node.children) {
+    if (child.type !== "element") continue;
+    if (localName(child.name) === local) return child;
+    const nested = findFirstDescendant(child, local);
+    if (nested) return nested;
+  }
+  return undefined;
+}
+
 function readTableStyleId(node: XmlElementNode): string | undefined {
   for (const child of node.children) {
     if (child.type !== "element" || localName(child.name) !== "tblStyle") continue;
@@ -2007,3 +2163,252 @@ function decodeXmlEntities(value: string): string {
     }
   });
 }
+
+// ---- Section properties parsing ----
+
+function parseSectionBreakElement(
+  node: XmlElementNode,
+  sourceXml: string,
+): ParsedSectionBreakNode {
+  const props = parseSectionPropertiesFromElement(node);
+  return {
+    type: "section_break",
+    sectionPropertiesXml: sourceXml.slice(node.start, node.end),
+    sectionProperties: props,
+  };
+}
+
+function readSectionPropertiesFromPPr(
+  pPrNode: XmlElementNode,
+): SectionProperties | undefined {
+  for (const child of pPrNode.children) {
+    if (child.type === "element" && localName(child.name) === "sectPr") {
+      return parseSectionPropertiesFromElement(child);
+    }
+  }
+  return undefined;
+}
+
+function readSectionPropertiesXmlFromPPr(
+  pPrNode: XmlElementNode,
+  sourceXml: string,
+): string | undefined {
+  for (const child of pPrNode.children) {
+    if (child.type === "element" && localName(child.name) === "sectPr") {
+      return sourceXml.slice(child.start, child.end);
+    }
+  }
+  return undefined;
+}
+
+export function parseSectionPropertiesFromElement(
+  node: XmlElementNode,
+): SectionProperties {
+  const props: SectionProperties = {};
+
+  for (const child of node.children) {
+    if (child.type !== "element") continue;
+    const name = localName(child.name);
+
+    switch (name) {
+      case "pgSz": {
+        const w = safeParseInt(child.attributes["w:w"]);
+        const h = safeParseInt(child.attributes["w:h"]);
+        if (w !== undefined && h !== undefined) {
+          const pageSize: PageSize = { width: w, height: h };
+          const orient = child.attributes["w:orient"];
+          if (orient === "landscape" || orient === "portrait") {
+            pageSize.orientation = orient;
+          }
+          props.pageSize = pageSize;
+        }
+        break;
+      }
+      case "pgMar": {
+        const top = safeParseInt(child.attributes["w:top"]);
+        const right = safeParseInt(child.attributes["w:right"]);
+        const bottom = safeParseInt(child.attributes["w:bottom"]);
+        const left = safeParseInt(child.attributes["w:left"]);
+        if (top !== undefined && right !== undefined && bottom !== undefined && left !== undefined) {
+          const margins: PageMargins = { top, right, bottom, left };
+          const header = safeParseInt(child.attributes["w:header"]);
+          const footer = safeParseInt(child.attributes["w:footer"]);
+          const gutter = safeParseInt(child.attributes["w:gutter"]);
+          if (header !== undefined) margins.header = header;
+          if (footer !== undefined) margins.footer = footer;
+          if (gutter !== undefined) margins.gutter = gutter;
+          props.pageMargins = margins;
+        }
+        break;
+      }
+      case "cols": {
+        const columns: ColumnProperties = {};
+        const num = safeParseInt(child.attributes["w:num"]);
+        const space = safeParseInt(child.attributes["w:space"]);
+        const equalWidth = child.attributes["w:equalWidth"];
+        const sep = child.attributes["w:sep"];
+        if (num !== undefined) columns.count = num;
+        if (space !== undefined) columns.space = space;
+        if (equalWidth !== undefined) columns.equalWidth = equalWidth !== "0" && equalWidth !== "false";
+        if (sep === "1" || sep === "true") columns.separator = true;
+        const colDefs: Array<{ width: number; space?: number }> = [];
+        for (const colChild of child.children) {
+          if (colChild.type === "element" && localName(colChild.name) === "col") {
+            const colW = safeParseInt(colChild.attributes["w:w"]);
+            const colSpace = safeParseInt(colChild.attributes["w:space"]);
+            if (colW !== undefined) {
+              colDefs.push(colSpace !== undefined ? { width: colW, space: colSpace } : { width: colW });
+            }
+          }
+        }
+        if (colDefs.length > 0) columns.columns = colDefs;
+        if (Object.keys(columns).length > 0) props.columns = columns;
+        break;
+      }
+      case "pgNumType": {
+        const numbering: PageNumbering = {};
+        const fmt = child.attributes["w:fmt"];
+        const start = safeParseInt(child.attributes["w:start"]);
+        const chapStyle = child.attributes["w:chapStyle"];
+        const chapSep = child.attributes["w:chapSep"];
+        if (fmt) numbering.format = fmt;
+        if (start !== undefined) numbering.start = start;
+        if (chapStyle) numbering.chapStyle = chapStyle;
+        if (chapSep) numbering.chapSep = chapSep;
+        if (Object.keys(numbering).length > 0) props.pageNumbering = numbering;
+        break;
+      }
+      case "lnNumType": {
+        const lineNumbering: SectionLineNumbering = {};
+        const countBy = safeParseInt(child.attributes["w:countBy"]);
+        const start = safeParseInt(child.attributes["w:start"]);
+        const distance = safeParseInt(child.attributes["w:distance"]);
+        const restart = child.attributes["w:restart"];
+        if (countBy !== undefined) lineNumbering.countBy = countBy;
+        if (start !== undefined) lineNumbering.start = start;
+        if (distance !== undefined) lineNumbering.distance = distance;
+        if (
+          restart === "newPage" ||
+          restart === "newSection" ||
+          restart === "continuous"
+        ) {
+          lineNumbering.restart = restart;
+        }
+        if (Object.keys(lineNumbering).length > 0) {
+          props.lineNumbering = lineNumbering;
+        }
+        break;
+      }
+      case "pgBorders": {
+        const pageBorders: SectionPageBorders = {};
+        const offsetFrom = child.attributes["w:offsetFrom"];
+        const display = child.attributes["w:display"];
+        const zOrder = child.attributes["w:zOrder"];
+        if (offsetFrom === "page" || offsetFrom === "text") {
+          pageBorders.offsetFrom = offsetFrom;
+        }
+        if (
+          display === "allPages" ||
+          display === "firstPage" ||
+          display === "notFirstPage"
+        ) {
+          pageBorders.display = display;
+        }
+        if (zOrder === "front" || zOrder === "back") {
+          pageBorders.zOrder = zOrder;
+        }
+        for (const borderChild of child.children) {
+          if (borderChild.type !== "element") continue;
+          const borderName = localName(borderChild.name);
+          const border = parseBorderSpec(borderChild);
+          if (!border) continue;
+          if (
+            borderName === "top" ||
+            borderName === "left" ||
+            borderName === "bottom" ||
+            borderName === "right"
+          ) {
+            pageBorders[borderName] = border;
+          }
+        }
+        if (Object.keys(pageBorders).length > 0) {
+          props.pageBorders = pageBorders;
+        }
+        break;
+      }
+      case "docGrid": {
+        const documentGrid: SectionDocumentGrid = {};
+        const type = child.attributes["w:type"];
+        const linePitch = safeParseInt(child.attributes["w:linePitch"]);
+        const charSpace = safeParseInt(child.attributes["w:charSpace"]);
+        if (
+          type === "default" ||
+          type === "lines" ||
+          type === "linesAndChars" ||
+          type === "snapToChars"
+        ) {
+          documentGrid.type = type;
+        }
+        if (linePitch !== undefined) documentGrid.linePitch = linePitch;
+        if (charSpace !== undefined) documentGrid.charSpace = charSpace;
+        if (Object.keys(documentGrid).length > 0) {
+          props.documentGrid = documentGrid;
+        }
+        break;
+      }
+      case "headerReference": {
+        const variant = child.attributes["w:type"] as HeaderFooterVariant | undefined;
+        const rId = child.attributes["r:id"];
+        if (variant && rId) {
+          if (!props.headerReferences) props.headerReferences = [];
+          props.headerReferences.push({ variant, relationshipId: rId });
+        }
+        break;
+      }
+      case "footerReference": {
+        const variant = child.attributes["w:type"] as HeaderFooterVariant | undefined;
+        const rId = child.attributes["r:id"];
+        if (variant && rId) {
+          if (!props.footerReferences) props.footerReferences = [];
+          props.footerReferences.push({ variant, relationshipId: rId });
+        }
+        break;
+      }
+      case "type": {
+        const val = child.attributes["w:val"];
+        if (val === "continuous" || val === "nextPage" || val === "evenPage" || val === "oddPage" || val === "nextColumn") {
+          props.sectionType = val;
+        }
+        break;
+      }
+      case "titlePg": {
+        const val = child.attributes["w:val"];
+        props.titlePage = val !== "false" && val !== "0";
+        break;
+      }
+    }
+  }
+
+  return props;
+}
+
+function safeParseInt(value: string | undefined): number | undefined {
+  if (value === undefined) return undefined;
+  const n = Number.parseInt(value, 10);
+  return Number.isFinite(n) ? n : undefined;
+}
+
+function parseBorderSpec(node: XmlElementNode): BorderSpec | undefined {
+  const border: BorderSpec = {};
+  const value = node.attributes["w:val"];
+  const size = safeParseInt(node.attributes["w:sz"]);
+  const space = safeParseInt(node.attributes["w:space"]);
+  const color = node.attributes["w:color"];
+
+  if (value) border.value = value;
+  if (size !== undefined) border.size = size;
+  if (space !== undefined) border.space = space;
+  if (color) border.color = color;
+
+  return Object.keys(border).length > 0 ? border : undefined;
+}

package/src/io/ooxml/parse-numbering.ts

@@ -147,6 +147,11 @@ function readLevels(abstractNode: XmlElementNode): NumberingLevelDefinition[] {
     const text = textNode?.attributes["w:val"] ?? textNode?.attributes.val ?? `%${level + 1}.`;
     const paragraphStyleId =
       paragraphStyleNode?.attributes["w:val"] ?? paragraphStyleNode?.attributes.val;
+    const isLegalNode = findChildElementOptional(child, "isLgl");
+    const isLegalNumbering = isLegalNode !== undefined;
+    const suffixNode = findChildElementOptional(child, "suff");
+    const suffixVal = suffixNode?.attributes["w:val"] ?? suffixNode?.attributes.val;
+    const suffix = suffixVal === "space" || suffixVal === "nothing" ? suffixVal : suffixVal === "tab" ? "tab" : undefined;
 
     levels.push({
       level,
@@ -154,6 +159,8 @@ function readLevels(abstractNode: XmlElementNode): NumberingLevelDefinition[] {
       text,
       ...(startAt !== undefined ? { startAt } : {}),
       ...(paragraphStyleId ? { paragraphStyleId } : {}),
+      ...(isLegalNumbering ? { isLegalNumbering } : {}),
+      ...(suffix ? { suffix } : {}),
     });
   }