docxmlater 11.0.9 → 12.0.1

package/dist/esm/elements/Revision.js

@@ -1,4 +1,5 @@
 import { Run } from './Run.js';
+import { XMLBuilder } from '../xml/XMLBuilder.js';
 import { isRunContent, isHyperlinkContent } from './RevisionContent.js';
 import { formatDateForXml } from '../utils/dateFormatting.js';
 export class Revision {
@@ -188,9 +189,6 @@ export class Revision {
             'w:author': this.author,
             'w:date': this.formatDate(this.date),
         };
-        if ((this.type === 'moveFrom' || this.type === 'moveTo') && this.moveId) {
-            attributes['w:moveId'] = this.moveId;
-        }
         const elementName = this.getElementName();
         const children = [];
         if (this.isPropertyChangeType()) {
@@ -198,10 +196,50 @@ export class Revision {
                 children.push(this.createPropertiesElement());
             }
         }
-        const firstItem = this.content[0];
-        const singleHyperlink = this.content.length === 1 && firstItem && isHyperlinkContent(firstItem) ? firstItem : null;
-        if (singleHyperlink && !this.isPropertyChangeType()) {
-            return this.createHyperlinkWrappedRevisionXml(singleHyperlink, elementName, attributes);
+        if (!this.isPropertyChangeType()) {
+            const segments = [];
+            const segmentAttributes = (segmentIndex) => segmentIndex === 0
+                ? attributes
+                : {
+                    ...attributes,
+                    'w:id': String(500000000 + (this.id % 1000000) * 1000 + segmentIndex),
+                };
+            let pendingRuns = [];
+            const flushRuns = () => {
+                if (pendingRuns.length > 0) {
+                    segments.push({
+                        name: elementName,
+                        attributes: segmentAttributes(segments.length),
+                        children: pendingRuns,
+                    });
+                    pendingRuns = [];
+                }
+            };
+            for (const item of this.content) {
+                if (isHyperlinkContent(item)) {
+                    flushRuns();
+                    segments.push(this.createHyperlinkWrappedRevisionXml(item, elementName, segmentAttributes(segments.length)));
+                }
+                else if (isRunContent(item)) {
+                    if (this.type === 'delete' || this.type === 'moveFrom') {
+                        pendingRuns.push(this.createDeletedRunXml(item));
+                    }
+                    else {
+                        pendingRuns.push(item.toXML());
+                    }
+                }
+            }
+            flushRuns();
+            if (segments.length === 0) {
+                return { name: elementName, attributes, children: [] };
+            }
+            if (segments.length === 1) {
+                return segments[0];
+            }
+            return {
+                name: '__rawXml',
+                rawXml: segments.map((segment) => XMLBuilder.elementToString(segment)).join(''),
+            };
         }
         for (const item of this.content) {
             if (isHyperlinkContent(item)) {
@@ -209,24 +247,13 @@ export class Revision {
                 if (hyperlinkXml.children) {
                     for (const child of hyperlinkXml.children) {
                         if (typeof child === 'object' && child.name === 'w:r') {
-                            if (this.type === 'delete' || this.type === 'moveFrom') {
-                                children.push(this.convertRunXmlToDeleted(child));
-                            }
-                            else {
-                                children.push(child);
-                            }
+                            children.push(child);
                         }
                     }
                 }
             }
             else if (isRunContent(item)) {
-                if (this.type === 'delete' || this.type === 'moveFrom') {
-                    const runXml = this.createDeletedRunXml(item);
-                    children.push(runXml);
-                }
-                else {
-                    children.push(item.toXML());
-                }
+                children.push(item.toXML());
             }
         }
         return {
@@ -279,27 +306,340 @@ export class Revision {
                 propElementName = 'w:numPr';
                 break;
         }
+        const keyMap = Revision.PROPERTY_KEY_TO_ELEMENT[this.type] ?? {};
         const propChildren = [];
         if (this.previousProperties) {
             for (const [key, value] of Object.entries(this.previousProperties)) {
-                if (typeof value === 'boolean' && value) {
-                    propChildren.push({ name: `w:${key}`, attributes: {}, children: [] });
-                }
-                else if (typeof value === 'string' || typeof value === 'number') {
-                    propChildren.push({
-                        name: `w:${key}`,
-                        attributes: { 'w:val': value.toString() },
-                        children: [],
-                    });
+                const child = this.createPreviousPropertyXml(`w:${keyMap[key] ?? key}`, value);
+                if (child) {
+                    propChildren.push(child);
                 }
             }
         }
+        const order = Revision.PROPERTY_CHILD_ORDER[propElementName];
+        if (order) {
+            const rank = (name) => {
+                const index = order.indexOf(name);
+                return index === -1 ? order.length : index;
+            };
+            propChildren.sort((a, b) => rank(a.name) - rank(b.name));
+        }
         return {
             name: propElementName,
             attributes: {},
             children: propChildren,
         };
     }
+    static PROPERTY_KEY_TO_ELEMENT = {
+        paragraphPropertiesChange: {
+            alignment: 'jc',
+            style: 'pStyle',
+            styleId: 'pStyle',
+            indentation: 'ind',
+            numbering: 'numPr',
+            outlineLevel: 'outlineLvl',
+            shading: 'shd',
+            borders: 'pBdr',
+        },
+        tablePropertiesChange: {
+            alignment: 'jc',
+            style: 'tblStyle',
+            styleId: 'tblStyle',
+            width: 'tblW',
+            indent: 'tblInd',
+            borders: 'tblBorders',
+            shading: 'shd',
+            layout: 'tblLayout',
+            cellMargins: 'tblCellMar',
+            cellSpacing: 'tblCellSpacing',
+        },
+        tableExceptionPropertiesChange: {
+            alignment: 'jc',
+            width: 'tblW',
+            indent: 'tblInd',
+            borders: 'tblBorders',
+            shading: 'shd',
+            layout: 'tblLayout',
+            cellMargins: 'tblCellMar',
+            cellSpacing: 'tblCellSpacing',
+        },
+        tableRowPropertiesChange: {
+            alignment: 'jc',
+            height: 'trHeight',
+            isHeader: 'tblHeader',
+            cellSpacing: 'tblCellSpacing',
+        },
+        tableCellPropertiesChange: {
+            width: 'tcW',
+            borders: 'tcBorders',
+            shading: 'shd',
+            verticalAlignment: 'vAlign',
+            margins: 'tcMar',
+        },
+        sectionPropertiesChange: {
+            pageSize: 'pgSz',
+            margins: 'pgMar',
+            columns: 'cols',
+            pageNumbering: 'pgNumType',
+        },
+    };
+    static PROPERTY_CHILD_ORDER = {
+        'w:pPr': [
+            'w:pStyle',
+            'w:keepNext',
+            'w:keepLines',
+            'w:pageBreakBefore',
+            'w:framePr',
+            'w:widowControl',
+            'w:numPr',
+            'w:suppressLineNumbers',
+            'w:pBdr',
+            'w:shd',
+            'w:tabs',
+            'w:suppressAutoHyphens',
+            'w:kinsoku',
+            'w:wordWrap',
+            'w:overflowPunct',
+            'w:topLinePunct',
+            'w:autoSpaceDE',
+            'w:autoSpaceDN',
+            'w:bidi',
+            'w:adjustRightInd',
+            'w:snapToGrid',
+            'w:spacing',
+            'w:ind',
+            'w:contextualSpacing',
+            'w:mirrorIndents',
+            'w:suppressOverlap',
+            'w:jc',
+            'w:textDirection',
+            'w:textAlignment',
+            'w:textboxTightWrap',
+            'w:outlineLvl',
+        ],
+        'w:tblPr': [
+            'w:tblStyle',
+            'w:tblpPr',
+            'w:tblOverlap',
+            'w:bidiVisual',
+            'w:tblStyleRowBandSize',
+            'w:tblStyleColBandSize',
+            'w:tblW',
+            'w:jc',
+            'w:tblCellSpacing',
+            'w:tblInd',
+            'w:tblBorders',
+            'w:shd',
+            'w:tblLayout',
+            'w:tblCellMar',
+            'w:tblLook',
+            'w:tblCaption',
+            'w:tblDescription',
+        ],
+        'w:tblPrEx': [
+            'w:tblW',
+            'w:jc',
+            'w:tblCellSpacing',
+            'w:tblInd',
+            'w:tblBorders',
+            'w:shd',
+            'w:tblLayout',
+            'w:tblCellMar',
+            'w:tblLook',
+        ],
+        'w:trPr': [
+            'w:cnfStyle',
+            'w:divId',
+            'w:gridBefore',
+            'w:gridAfter',
+            'w:wBefore',
+            'w:wAfter',
+            'w:cantSplit',
+            'w:trHeight',
+            'w:tblHeader',
+            'w:tblCellSpacing',
+            'w:jc',
+            'w:hidden',
+        ],
+        'w:tcPr': [
+            'w:cnfStyle',
+            'w:tcW',
+            'w:gridSpan',
+            'w:hMerge',
+            'w:vMerge',
+            'w:tcBorders',
+            'w:shd',
+            'w:noWrap',
+            'w:tcMar',
+            'w:textDirection',
+            'w:tcFitText',
+            'w:vAlign',
+            'w:hideMark',
+        ],
+        'w:sectPr': [
+            'w:headerReference',
+            'w:footerReference',
+            'w:footnotePr',
+            'w:endnotePr',
+            'w:type',
+            'w:pgSz',
+            'w:pgMar',
+            'w:paperSrc',
+            'w:pgBorders',
+            'w:lnNumType',
+            'w:pgNumType',
+            'w:cols',
+            'w:formProt',
+            'w:vAlign',
+            'w:noEndnote',
+            'w:titlePg',
+            'w:textDirection',
+            'w:bidi',
+            'w:rtlGutter',
+            'w:docGrid',
+        ],
+        'w:numPr': ['w:ilvl', 'w:numId', 'w:numberingChange', 'w:ins'],
+    };
+    createPreviousPropertyXml(name, value) {
+        if (typeof value === 'boolean') {
+            return { name, attributes: value ? {} : { 'w:val': '0' }, children: [] };
+        }
+        if (typeof value === 'string' || typeof value === 'number') {
+            return { name, attributes: { 'w:val': value.toString() }, children: [] };
+        }
+        if (value && typeof value === 'object') {
+            return this.createObjectPropertyXml(name, value);
+        }
+        return null;
+    }
+    createObjectPropertyXml(name, value) {
+        switch (name) {
+            case 'w:spacing':
+                return {
+                    name,
+                    attributes: XMLBuilder.buildAttributes({
+                        'w:before': value.before,
+                        'w:beforeLines': value.beforeLines,
+                        'w:beforeAutospacing': value.beforeAutospacing === undefined
+                            ? undefined
+                            : value.beforeAutospacing
+                                ? '1'
+                                : '0',
+                        'w:after': value.after,
+                        'w:afterLines': value.afterLines,
+                        'w:afterAutospacing': value.afterAutospacing === undefined ? undefined : value.afterAutospacing ? '1' : '0',
+                        'w:line': value.line,
+                        'w:lineRule': value.lineRule,
+                    }),
+                    children: [],
+                };
+            case 'w:ind':
+                return {
+                    name,
+                    attributes: XMLBuilder.buildAttributes({
+                        'w:start': value.start,
+                        'w:end': value.end,
+                        'w:left': value.left,
+                        'w:leftChars': value.leftChars,
+                        'w:right': value.right,
+                        'w:rightChars': value.rightChars,
+                        'w:firstLine': value.firstLine,
+                        'w:firstLineChars': value.firstLineChars,
+                        'w:hanging': value.hanging,
+                        'w:hangingChars': value.hangingChars,
+                    }),
+                    children: [],
+                };
+            case 'w:numPr': {
+                const numPrChildren = [];
+                const level = value.level ?? value.ilvl;
+                const numId = value.numId ?? value.id;
+                if (level !== undefined) {
+                    numPrChildren.push({
+                        name: 'w:ilvl',
+                        attributes: { 'w:val': String(level) },
+                        children: [],
+                    });
+                }
+                if (numId !== undefined) {
+                    numPrChildren.push({
+                        name: 'w:numId',
+                        attributes: { 'w:val': String(numId) },
+                        children: [],
+                    });
+                }
+                return numPrChildren.length > 0 ? { name, attributes: {}, children: numPrChildren } : null;
+            }
+            case 'w:shd':
+                return XMLBuilder.createShading(value);
+            case 'w:pBdr':
+            case 'w:tblBorders':
+            case 'w:tcBorders': {
+                const sides = name === 'w:pBdr'
+                    ? ['top', 'left', 'bottom', 'right', 'between', 'bar']
+                    : ['top', 'left', 'bottom', 'right', 'insideH', 'insideV'];
+                const borderChildren = [];
+                for (const side of sides) {
+                    if (value[side]) {
+                        borderChildren.push(XMLBuilder.createBorder(side, value[side]));
+                    }
+                }
+                return borderChildren.length > 0
+                    ? { name, attributes: {}, children: borderChildren }
+                    : null;
+            }
+            case 'w:tblW':
+            case 'w:tcW':
+            case 'w:tblInd':
+            case 'w:tblCellSpacing':
+                return {
+                    name,
+                    attributes: XMLBuilder.buildAttributes({
+                        'w:w': value.w ?? value.width ?? value.value,
+                        'w:type': value.type ?? 'dxa',
+                    }),
+                    children: [],
+                };
+            case 'w:trHeight':
+                return {
+                    name,
+                    attributes: XMLBuilder.buildAttributes({
+                        'w:val': value.value ?? value.val ?? value.height,
+                        'w:hRule': value.rule ?? value.hRule,
+                    }),
+                    children: [],
+                };
+            case 'w:tcMar':
+            case 'w:tblCellMar':
+                return XMLBuilder.createMargins(name.slice(2), value);
+            case 'w:pgSz':
+                return {
+                    name,
+                    attributes: XMLBuilder.buildAttributes({
+                        'w:w': value.width ?? value.w,
+                        'w:h': value.height ?? value.h,
+                        'w:orient': value.orientation ?? value.orient,
+                    }),
+                    children: [],
+                };
+            case 'w:pgMar':
+                return {
+                    name,
+                    attributes: XMLBuilder.buildAttributes({
+                        'w:top': value.top,
+                        'w:right': value.right,
+                        'w:bottom': value.bottom,
+                        'w:left': value.left,
+                        'w:header': value.header,
+                        'w:footer': value.footer,
+                        'w:gutter': value.gutter,
+                    }),
+                    children: [],
+                };
+            default:
+                return null;
+        }
+    }
     createDeletedRunXml(run) {
         const runXml = run.toXML();
         const deletedTextElement = this.isFieldInstruction ? 'w:delInstrText' : 'w:delText';