fix: child export app.xml stats to use main document counts

Author: harbournick

packages/super-editor/src/core/super-converter/SuperConverter.js

@@ -21,7 +21,7 @@ import {
 } from './v2/exporter/commentsExporter.js';
 import { prepareFootnotesXmlForExport } from './v2/exporter/footnotesExporter.js';
 import { writeAppStatistics } from '../../document-api-adapters/helpers/app-properties.js';
-import { getWordStatistics } from '../../document-api-adapters/helpers/word-statistics.js';
+import { getWordStatistics, resolveMainBodyEditor } from '../../document-api-adapters/helpers/word-statistics.js';
 import { refreshAllStatFields } from '../../document-api-adapters/helpers/refresh-stat-fields.js';
 import { ensureSettingsRoot, hasUpdateFields, setUpdateFields } from '../../document-api-adapters/document-settings.js';
 import { importFootnoteData, importEndnoteData } from './v2/importer/documentFootnotesImporter.js';
@@ -1334,7 +1334,12 @@ class SuperConverter {
     if (!editor) return;
 
     try {
-      const stats = getWordStatistics(editor);
+      // docProps/app.xml is document-scoped metadata. When export runs from a
+      // linked child editor (for example a header/footer editor), compute the
+      // statistics from the main body editor so package-level counts stay
+      // aligned with Word's document-level stat-field semantics.
+      const statsEditor = resolveMainBodyEditor(editor);
+      const stats = getWordStatistics(statsEditor);
       writeAppStatistics(this.convertedXml, stats);
 
       // Only set w:updateFields when the document actually contains a

packages/super-editor/src/tests/regression/opc-package-metadata-roundtrip.test.js

@@ -18,16 +18,30 @@ const TEST_DOC = 'blank-doc.docx';
 const CT_CUSTOM = 'application/vnd.openxmlformats-officedocument.custom-properties+xml';
 const REL_CUSTOM = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties';
 const WORD_STAT_TEXT = 'Alpha beta gamma';
+const PARENT_WORD_STAT_TEXT = 'Alpha beta gamma delta';
+const CHILD_ONLY_TEXT = 'Header words only';
 
 function readXmlTagValue(xml, tagName) {
   const match = xml.match(new RegExp(`<${tagName}>([^<]*)</${tagName}>`));
   return match?.[1] ?? null;
 }
 
+function readAppStatistics(xml) {
+  return {
+    words: readXmlTagValue(xml, 'Words'),
+    characters: readXmlTagValue(xml, 'Characters'),
+    charactersWithSpaces: readXmlTagValue(xml, 'CharactersWithSpaces'),
+  };
+}
+
+async function createHeadlessEditor(testDoc = TEST_DOC) {
+  const { docx, media, mediaFiles, fonts } = await loadTestDataForEditorTests(testDoc);
+  return initTestEditor({ content: docx, media, mediaFiles, fonts, isHeadless: true });
+}
+
 describe('OPC package metadata: custom-properties registration', () => {
   it('getUpdatedDocs includes correct [Content_Types].xml and _rels/.rels for new custom.xml', async () => {
-    const { docx, media, mediaFiles, fonts } = await loadTestDataForEditorTests(TEST_DOC);
-    const { editor } = initTestEditor({ content: docx, media, mediaFiles, fonts, isHeadless: true });
+    const { editor } = await createHeadlessEditor();
 
     try {
       const updatedDocs = await editor.exportDocx({ getUpdatedDocs: true });
@@ -54,8 +68,7 @@ describe('OPC package metadata: custom-properties registration', () => {
   });
 
   it('zipped export includes valid package metadata for new custom.xml', async () => {
-    const { docx, media, mediaFiles, fonts } = await loadTestDataForEditorTests(TEST_DOC);
-    const { editor } = initTestEditor({ content: docx, media, mediaFiles, fonts, isHeadless: true });
+    const { editor } = await createHeadlessEditor();
 
     try {
       const exportedBuffer = await editor.exportDocx({ compression: 'STORE' });
@@ -92,8 +105,7 @@ describe('OPC package metadata: custom-properties registration', () => {
   });
 
   it('preserves existing managed registrations without duplication', async () => {
-    const { docx, media, mediaFiles, fonts } = await loadTestDataForEditorTests(TEST_DOC);
-    const { editor } = initTestEditor({ content: docx, media, mediaFiles, fonts, isHeadless: true });
+    const { editor } = await createHeadlessEditor();
 
     try {
       const updatedDocs = await editor.exportDocx({ getUpdatedDocs: true });
@@ -130,8 +142,7 @@ describe('OPC package metadata: custom-properties registration', () => {
   });
 
   it('getUpdatedDocs includes refreshed docProps/app.xml statistics', async () => {
-    const { docx, media, mediaFiles, fonts } = await loadTestDataForEditorTests(TEST_DOC);
-    const { editor } = initTestEditor({ content: docx, media, mediaFiles, fonts, isHeadless: true });
+    const { editor } = await createHeadlessEditor();
 
     try {
       editor.commands.insertContent(WORD_STAT_TEXT);
@@ -140,10 +151,40 @@ describe('OPC package metadata: custom-properties registration', () => {
       const appXml = updatedDocs['docProps/app.xml'];
 
       expect(appXml).toBeTruthy();
-      expect(readXmlTagValue(appXml, 'Words')).toBe('3');
-      expect(readXmlTagValue(appXml, 'Characters')).toBe('14');
-      expect(readXmlTagValue(appXml, 'CharactersWithSpaces')).toBe('16');
+      expect(readAppStatistics(appXml)).toEqual({
+        words: '3',
+        characters: '14',
+        charactersWithSpaces: '16',
+      });
+    } finally {
+      editor.destroy();
+    }
+  });
+
+  it('linked child exports keep docProps/app.xml statistics scoped to the main document', async () => {
+    const { editor } = await createHeadlessEditor();
+    let childEditor = null;
+
+    try {
+      editor.commands.insertContent(PARENT_WORD_STAT_TEXT);
+
+      childEditor = editor.createChildEditor({
+        isHeadless: true,
+        isHeaderOrFooter: true,
+      });
+      childEditor.commands.insertContent(CHILD_ONLY_TEXT);
+
+      const updatedDocs = await childEditor.exportDocx({ getUpdatedDocs: true });
+      const appXml = updatedDocs['docProps/app.xml'];
+
+      expect(appXml).toBeTruthy();
+      expect(readAppStatistics(appXml)).toEqual({
+        words: '4',
+        characters: '19',
+        charactersWithSpaces: '22',
+      });
     } finally {
+      childEditor?.destroy();
       editor.destroy();
     }
   });