docxmlater 11.0.9 → 12.0.1

package/src/elements/Section.ts

@@ -1646,8 +1646,13 @@ export class Section {
    * @returns New Section instance with copied properties
    */
   clone(): Section {
-    // Deep clone all nested objects
-    const clonedProperties: SectionProperties = {};
+    // Spread the full properties object first so every SectionProperties field is
+    // preserved (primitives such as type/titlePage/bidi as well as the fields the
+    // old allow-list silently dropped: footnotePr, endnotePr, noEndnote, formProt,
+    // pageBorders, printerSettingsId, chapStyle, chapSep). Then overwrite the
+    // object-typed fields with deep copies so the clone is independent of the
+    // original. This mirrors the constructor's preserve-everything approach.
+    const clonedProperties: SectionProperties = { ...this.properties };
 
     if (this.properties.pageSize) {
       clonedProperties.pageSize = { ...this.properties.pageSize };
@@ -1693,13 +1698,24 @@ export class Section {
       clonedProperties.lineNumbering = { ...this.properties.lineNumbering };
     }
 
-    // Copy primitive properties
-    clonedProperties.type = this.properties.type;
-    clonedProperties.titlePage = this.properties.titlePage;
-    clonedProperties.verticalAlignment = this.properties.verticalAlignment;
-    clonedProperties.textDirection = this.properties.textDirection;
-    clonedProperties.bidi = this.properties.bidi;
-    clonedProperties.rtlGutter = this.properties.rtlGutter;
+    if (this.properties.footnotePr) {
+      clonedProperties.footnotePr = { ...this.properties.footnotePr };
+    }
+
+    if (this.properties.endnotePr) {
+      clonedProperties.endnotePr = { ...this.properties.endnotePr };
+    }
+
+    if (this.properties.pageBorders) {
+      const pb = this.properties.pageBorders;
+      clonedProperties.pageBorders = {
+        ...pb,
+        top: pb.top ? { ...pb.top } : undefined,
+        bottom: pb.bottom ? { ...pb.bottom } : undefined,
+        left: pb.left ? { ...pb.left } : undefined,
+        right: pb.right ? { ...pb.right } : undefined,
+      };
+    }
 
     return new Section(clonedProperties);
   }

package/src/elements/Shape.ts

@@ -503,58 +503,66 @@ export class Shape {
       selfClosing: true,
     });
 
-    // Position H (horizontal)
-    if (this.position) {
-      const posH = this.position.horizontal;
-      const posHChildren: XMLElement[] = [];
-
-      if (posH.offset !== undefined) {
-        posHChildren.push({
-          name: 'wp:posOffset',
-          children: [posH.offset.toString()],
-        });
-      } else if (posH.alignment) {
-        posHChildren.push({
-          name: 'wp:align',
-          children: [posH.alignment],
-        });
-      }
-
-      children.push({
-        name: 'wp:positionH',
-        attributes: {
-          relativeFrom: posH.anchor,
-        },
-        children: posHChildren,
+    // Position H (horizontal) — required child of wp:anchor per CT_Anchor
+    // (minOccurs=1), so fall back to a zero page offset when no explicit
+    // position is configured (anchor-only floating shapes)
+    const posH = this.position?.horizontal;
+    const posHChildren: XMLElement[] = [];
+
+    if (posH?.offset !== undefined) {
+      posHChildren.push({
+        name: 'wp:posOffset',
+        children: [posH.offset.toString()],
+      });
+    } else if (posH?.alignment) {
+      posHChildren.push({
+        name: 'wp:align',
+        children: [posH.alignment],
+      });
+    } else {
+      posHChildren.push({
+        name: 'wp:posOffset',
+        children: ['0'],
       });
     }
 
-    // Position V (vertical)
-    if (this.position) {
-      const posV = this.position.vertical;
-      const posVChildren: XMLElement[] = [];
+    children.push({
+      name: 'wp:positionH',
+      attributes: {
+        relativeFrom: posH?.anchor ?? 'page',
+      },
+      children: posHChildren,
+    });
 
-      if (posV.offset !== undefined) {
-        posVChildren.push({
-          name: 'wp:posOffset',
-          children: [posV.offset.toString()],
-        });
-      } else if (posV.alignment) {
-        posVChildren.push({
-          name: 'wp:align',
-          children: [posV.alignment],
-        });
-      }
+    // Position V (vertical) — required child of wp:anchor per CT_Anchor
+    const posV = this.position?.vertical;
+    const posVChildren: XMLElement[] = [];
 
-      children.push({
-        name: 'wp:positionV',
-        attributes: {
-          relativeFrom: posV.anchor,
-        },
-        children: posVChildren,
+    if (posV?.offset !== undefined) {
+      posVChildren.push({
+        name: 'wp:posOffset',
+        children: [posV.offset.toString()],
+      });
+    } else if (posV?.alignment) {
+      posVChildren.push({
+        name: 'wp:align',
+        children: [posV.alignment],
+      });
+    } else {
+      posVChildren.push({
+        name: 'wp:posOffset',
+        children: ['0'],
       });
     }
 
+    children.push({
+      name: 'wp:positionV',
+      attributes: {
+        relativeFrom: posV?.anchor ?? 'page',
+      },
+      children: posVChildren,
+    });
+
     // Extent (size)
     children.push({
       name: 'wp:extent',

package/src/elements/StructuredDocumentTag.ts

@@ -9,6 +9,8 @@
 import { XMLBuilder, XMLElement } from '../xml/XMLBuilder.js';
 import { Paragraph } from './Paragraph.js';
 import { Table } from './Table.js';
+import { PreservedElement } from './PreservedElement.js';
+import { formatDateForXml } from '../utils/dateFormatting.js';
 
 /**
  * Type of content lock for SDT
@@ -95,6 +97,10 @@ export interface CheckboxProperties {
   checkedState?: string;
   /** Character code for unchecked state (default: '2610' - ☐) */
   uncheckedState?: string;
+  /** Font for the checked-state glyph (default: 'MS Gothic') */
+  checkedFont?: string;
+  /** Font for the unchecked-state glyph (default: 'MS Gothic') */
+  uncheckedFont?: string;
 }
 
 /**
@@ -167,8 +173,12 @@ export interface SDTProperties {
 
 /**
  * Content that can be wrapped by an SDT
+ *
+ * PreservedElement covers CT_SdtContentBlock children outside the modeled
+ * set (range markers, w:customXml, math, tracked-change wrappers) so they
+ * survive round-trip instead of being dropped on regeneration.
  */
-export type SDTContent = Table | Paragraph | StructuredDocumentTag;
+export type SDTContent = Table | Paragraph | StructuredDocumentTag | PreservedElement;
 
 /**
  * Structured Document Tag class
@@ -191,6 +201,17 @@ export type SDTContent = Table | Paragraph | StructuredDocumentTag;
 export class StructuredDocumentTag {
   private properties: SDTProperties;
   private content: SDTContent[];
+  // Original w:sdtPr markup captured at parse time. toXML() rebuilds sdtPr
+  // from a modeled subset of CT_SdtPr, which would drop unmodeled children
+  // (w:rPr, w15:appearance, w15:color, w:label, w:tabIndex, w:temporary,
+  // w15:repeatingSection, ...) on every save — so while no modeled property
+  // has been mutated, the captured markup is re-emitted verbatim.
+  private rawSdtPrXml?: string;
+  // Original w:sdtEndPr markup. Never modeled, so always re-emitted.
+  private rawSdtEndPrXml?: string;
+  // Once a modeled sdtPr property changes, the preserved markup is stale;
+  // fall back to rebuilding sdtPr from the modeled subset.
+  private sdtPrMutated = false;
 
   /**
    * Create a new Structured Document Tag
@@ -202,6 +223,16 @@ export class StructuredDocumentTag {
     this.content = content;
   }
 
+  /** @internal */
+  _setRawSdtPrXml(xml: string): void {
+    this.rawSdtPrXml = xml;
+  }
+
+  /** @internal */
+  _setRawSdtEndPrXml(xml: string): void {
+    this.rawSdtEndPrXml = xml;
+  }
+
   /**
    * Get the SDT ID
    * @returns SDT ID or undefined
@@ -216,6 +247,7 @@ export class StructuredDocumentTag {
    */
   setId(id: number): this {
     this.properties.id = id;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -233,6 +265,7 @@ export class StructuredDocumentTag {
    */
   setTag(tag: string): this {
     this.properties.tag = tag;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -250,6 +283,7 @@ export class StructuredDocumentTag {
    */
   setLock(lock: SDTLockType): this {
     this.properties.lock = lock;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -267,6 +301,7 @@ export class StructuredDocumentTag {
    */
   setAlias(alias: string): this {
     this.properties.alias = alias;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -284,6 +319,7 @@ export class StructuredDocumentTag {
    */
   setControlType(type: ContentControlType): this {
     this.properties.controlType = type;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -302,6 +338,7 @@ export class StructuredDocumentTag {
   setPlainTextProperties(properties: PlainTextProperties): this {
     this.properties.controlType = 'plainText';
     this.properties.plainText = properties;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -320,6 +357,7 @@ export class StructuredDocumentTag {
   setComboBoxProperties(properties: ComboBoxProperties): this {
     this.properties.controlType = 'comboBox';
     this.properties.comboBox = properties;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -338,6 +376,7 @@ export class StructuredDocumentTag {
   setDropDownListProperties(properties: DropDownListProperties): this {
     this.properties.controlType = 'dropDownList';
     this.properties.dropDownList = properties;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -356,6 +395,7 @@ export class StructuredDocumentTag {
   setDatePickerProperties(properties: DatePickerProperties): this {
     this.properties.controlType = 'datePicker';
     this.properties.datePicker = properties;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -374,6 +414,7 @@ export class StructuredDocumentTag {
   setCheckboxProperties(properties: CheckboxProperties): this {
     this.properties.controlType = 'checkbox';
     this.properties.checkbox = properties;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -400,6 +441,7 @@ export class StructuredDocumentTag {
   setBuildingBlockProperties(properties: BuildingBlockProperties): this {
     this.properties.controlType = 'buildingBlock';
     this.properties.buildingBlock = properties;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -449,6 +491,7 @@ export class StructuredDocumentTag {
    */
   setTemporary(temporary: boolean): this {
     this.properties.temporary = temporary;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -565,7 +608,13 @@ export class StructuredDocumentTag {
                 })
               );
             }
-            sdtPrChildren.push(XMLBuilder.w('comboBox', {}, comboBoxChildren));
+            // w:lastValue records the last selected entry (CT_SdtComboBox);
+            // dropping it on rebuild loses the control's stored selection.
+            const comboBoxAttrs: Record<string, string> = {};
+            if (this.properties.comboBox.lastValue !== undefined) {
+              comboBoxAttrs['w:lastValue'] = this.properties.comboBox.lastValue;
+            }
+            sdtPrChildren.push(XMLBuilder.w('comboBox', comboBoxAttrs, comboBoxChildren));
           }
           break;
 
@@ -580,7 +629,12 @@ export class StructuredDocumentTag {
                 })
               );
             }
-            sdtPrChildren.push(XMLBuilder.w('dropDownList', {}, dropDownChildren));
+            // Same CT_SdtDropDownList w:lastValue preservation as comboBox.
+            const dropDownAttrs: Record<string, string> = {};
+            if (this.properties.dropDownList.lastValue !== undefined) {
+              dropDownAttrs['w:lastValue'] = this.properties.dropDownList.lastValue;
+            }
+            sdtPrChildren.push(XMLBuilder.w('dropDownList', dropDownAttrs, dropDownChildren));
           }
           break;
 
@@ -590,7 +644,9 @@ export class StructuredDocumentTag {
             // storeMappedDataAs, and calendar are child elements with w:val
             const dateAttrs: Record<string, string> = {};
             if (this.properties.datePicker.fullDate) {
-              dateAttrs['w:fullDate'] = this.properties.datePicker.fullDate.toISOString();
+              // formatDateForXml strips milliseconds — Word rejects them in
+              // ST_DateTime attributes, and toISOString() always emits them.
+              dateAttrs['w:fullDate'] = formatDateForXml(this.properties.datePicker.fullDate);
             }
             const dateChildren: XMLElement[] = [];
             if (this.properties.datePicker.dateFormat) {
@@ -635,12 +691,17 @@ export class StructuredDocumentTag {
               );
             }
 
-            // Add checked state symbol - use w14 namespace per OOXML spec
+            // Add checked state symbol - use w14 namespace per OOXML spec.
+            // The state pairs a character code with a glyph font
+            // (CT_SdtCheckboxSymbol); keep the parsed font so codes authored
+            // in e.g. Wingdings are not re-pointed at MS Gothic, where they
+            // map to wrong or missing glyphs. MS Gothic is only the default
+            // for programmatically created checkboxes (Word's stock symbols).
             if (this.properties.checkbox.checkedState) {
               checkboxChildren.push(
                 XMLBuilder.w14Self('checkedState', {
                   'w14:val': this.properties.checkbox.checkedState,
-                  'w14:font': 'MS Gothic',
+                  'w14:font': this.properties.checkbox.checkedFont ?? 'MS Gothic',
                 })
               );
             }
@@ -650,7 +711,7 @@ export class StructuredDocumentTag {
               checkboxChildren.push(
                 XMLBuilder.w14Self('uncheckedState', {
                   'w14:val': this.properties.checkbox.uncheckedState,
-                  'w14:font': 'MS Gothic',
+                  'w14:font': this.properties.checkbox.uncheckedFont ?? 'MS Gothic',
                 })
               );
             }
@@ -723,10 +784,20 @@ export class StructuredDocumentTag {
       }
     }
 
-    if (sdtPrChildren.length > 0) {
+    if (this.rawSdtPrXml !== undefined && !this.sdtPrMutated) {
+      // The rebuilt sdtPr above only covers the modeled subset of CT_SdtPr;
+      // emit the parse-time markup verbatim so unmodeled children survive.
+      children.push({ name: '__rawXml', rawXml: this.rawSdtPrXml });
+    } else if (sdtPrChildren.length > 0) {
       children.push(XMLBuilder.w('sdtPr', {}, sdtPrChildren));
     }
 
+    // w:sdtEndPr has no object model; re-emit the parse-time markup so it
+    // is not dropped on save (CT_SdtBlock order: sdtPr, sdtEndPr, sdtContent).
+    if (this.rawSdtEndPrXml !== undefined) {
+      children.push({ name: '__rawXml', rawXml: this.rawSdtEndPrXml });
+    }
+
     // Build sdtContent
     const sdtContentChildren: XMLElement[] = [];
     for (const element of this.content) {
@@ -1009,6 +1080,7 @@ export class StructuredDocumentTag {
    */
   unlock(): this {
     delete this.properties.lock;
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -1055,6 +1127,7 @@ export class StructuredDocumentTag {
    */
   setPlaceholder(docPart: string): this {
     this.properties.placeholder = { docPart };
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -1073,6 +1146,7 @@ export class StructuredDocumentTag {
    */
   setDataBinding(xpath: string, prefixMappings?: string, storeItemId?: string): this {
     this.properties.dataBinding = { xpath, prefixMappings, storeItemId };
+    this.sdtPrMutated = true;
     return this;
   }
 
@@ -1089,6 +1163,7 @@ export class StructuredDocumentTag {
    */
   setShowingPlaceholder(val: boolean): this {
     this.properties.showingPlcHdr = val;
+    this.sdtPrMutated = true;
     return this;
   }