easy-template-x 7.2.0 → 7.2.2

package/dist/cjs/easy-template-x.cjs

@@ -1074,7 +1074,7 @@ const TagPlacement = Object.freeze({
 
 function tagRegex(delimiters, global = false) {
   const tagOptionsPattern = `${Regex.escape(delimiters.tagOptionsStart)}(?<tagOptions>.*?)${Regex.escape(delimiters.tagOptionsEnd)}`;
-  const tagPattern = `${Regex.escape(delimiters.tagStart)}(?<tagName>.*?)(${tagOptionsPattern})?${Regex.escape(delimiters.tagEnd)}`;
+  const tagPattern = `${Regex.escape(delimiters.tagStart)}(?<tagName>.*?)(?:\\s*${tagOptionsPattern})?\\s*${Regex.escape(delimiters.tagEnd)}`;
   const flags = global ? 'gm' : 'm';
   return new RegExp(tagPattern, flags);
 }
@@ -1963,6 +1963,9 @@ class Query {
   isRunPropertiesNode(node) {
     return node.nodeName === OmlNode.W.RunProperties || node.nodeName === OmlNode.A.RunProperties;
   }
+  isTableNode(node) {
+    return node.nodeName === OmlNode.W.Table;
+  }
   isTableCellNode(node) {
     return node.nodeName === OmlNode.W.TableCell;
   }
@@ -3409,6 +3412,11 @@ class LoopParagraphStrategy {
       }
     }
 
+    // We cannot leave table cells completely empty, so we track them.
+    // See: http://officeopenxml.com/WPtableCell.php
+    const firstTableCell = officeMarkup.query.containingTableCellNode(firstParagraph);
+    const lastTableCell = officeMarkup.query.containingTableCellNode(lastParagraph);
+
     // Remove old paragraphs - between first and last paragraph.
     xml.modify.removeSiblings(firstParagraph, lastParagraph);
 
@@ -3417,6 +3425,17 @@ class LoopParagraphStrategy {
     if (firstParagraph !== lastParagraph) {
       xml.modify.remove(lastParagraph);
     }
+
+    // Make sure the table cells are not empty (if they exist).
+    if (newParagraphs.length === 0) {
+      this.fillTableCell(firstTableCell);
+      this.fillTableCell(lastTableCell);
+    }
+  }
+  fillTableCell(tableCell) {
+    if (tableCell && !tableCell.childNodes?.find(node => officeMarkup.query.isParagraphNode(node)) && !tableCell.childNodes?.find(node => officeMarkup.query.isTableNode(node))) {
+      xml.modify.appendChild(tableCell, xml.create.generalNode(OmlNode.W.Paragraph));
+    }
   }
 }
 
@@ -5293,7 +5312,7 @@ class TemplateHandler {
   /**
    * Version number of the `easy-template-x` library.
    */
-  version = "7.2.0" ;
+  version = "7.2.2" ;
   constructor(options) {
     this.options = new TemplateHandlerOptions(options);
     const delimiters = this.options.delimiters;

package/dist/es/easy-template-x.mjs

@@ -1072,7 +1072,7 @@ const TagPlacement = Object.freeze({
 
 function tagRegex(delimiters, global = false) {
   const tagOptionsPattern = `${Regex.escape(delimiters.tagOptionsStart)}(?<tagOptions>.*?)${Regex.escape(delimiters.tagOptionsEnd)}`;
-  const tagPattern = `${Regex.escape(delimiters.tagStart)}(?<tagName>.*?)(${tagOptionsPattern})?${Regex.escape(delimiters.tagEnd)}`;
+  const tagPattern = `${Regex.escape(delimiters.tagStart)}(?<tagName>.*?)(?:\\s*${tagOptionsPattern})?\\s*${Regex.escape(delimiters.tagEnd)}`;
   const flags = global ? 'gm' : 'm';
   return new RegExp(tagPattern, flags);
 }
@@ -1961,6 +1961,9 @@ class Query {
   isRunPropertiesNode(node) {
     return node.nodeName === OmlNode.W.RunProperties || node.nodeName === OmlNode.A.RunProperties;
   }
+  isTableNode(node) {
+    return node.nodeName === OmlNode.W.Table;
+  }
   isTableCellNode(node) {
     return node.nodeName === OmlNode.W.TableCell;
   }
@@ -3407,6 +3410,11 @@ class LoopParagraphStrategy {
       }
     }
 
+    // We cannot leave table cells completely empty, so we track them.
+    // See: http://officeopenxml.com/WPtableCell.php
+    const firstTableCell = officeMarkup.query.containingTableCellNode(firstParagraph);
+    const lastTableCell = officeMarkup.query.containingTableCellNode(lastParagraph);
+
     // Remove old paragraphs - between first and last paragraph.
     xml.modify.removeSiblings(firstParagraph, lastParagraph);
 
@@ -3415,6 +3423,17 @@ class LoopParagraphStrategy {
     if (firstParagraph !== lastParagraph) {
       xml.modify.remove(lastParagraph);
     }
+
+    // Make sure the table cells are not empty (if they exist).
+    if (newParagraphs.length === 0) {
+      this.fillTableCell(firstTableCell);
+      this.fillTableCell(lastTableCell);
+    }
+  }
+  fillTableCell(tableCell) {
+    if (tableCell && !tableCell.childNodes?.find(node => officeMarkup.query.isParagraphNode(node)) && !tableCell.childNodes?.find(node => officeMarkup.query.isTableNode(node))) {
+      xml.modify.appendChild(tableCell, xml.create.generalNode(OmlNode.W.Paragraph));
+    }
   }
 }
 
@@ -5291,7 +5310,7 @@ class TemplateHandler {
   /**
    * Version number of the `easy-template-x` library.
    */
-  version = "7.2.0" ;
+  version = "7.2.2" ;
   constructor(options) {
     this.options = new TemplateHandlerOptions(options);
     const delimiters = this.options.delimiters;

package/dist/types/office/officeMarkup.d.ts

@@ -8,6 +8,7 @@ declare class Query {
     isTextNode(node: XmlNode): boolean;
     isRunNode(node: XmlNode): boolean;
     isRunPropertiesNode(node: XmlNode): boolean;
+    isTableNode(node: XmlNode): boolean;
     isTableCellNode(node: XmlNode): boolean;
     isParagraphNode(node: XmlNode): boolean;
     isParagraphPropertiesNode(node: XmlNode): boolean;

package/dist/types/plugins/loop/strategy/loopParagraphStrategy.d.ts

@@ -5,4 +5,5 @@ export declare class LoopParagraphStrategy implements ILoopStrategy {
     isApplicable(openTag: TextNodeTag, closeTag: TextNodeTag, isCondition: boolean): boolean;
     splitBefore(openTag: TextNodeTag, closeTag: TextNodeTag): SplitBeforeResult;
     mergeBack(newParagraphs: XmlNode[][], firstParagraph: XmlNode, lastParagraph: XmlNode): void;
+    private fillTableCell;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easy-template-x",
-  "version": "7.2.0",
+  "version": "7.2.2",
   "description": "Generate docx documents from templates, in Node or in the browser.",
   "keywords": [
     "docx",

package/src/compilation/tagParser.tests.ts

@@ -759,6 +759,59 @@ describe(TagParser, () => {
             expect(tags[1].rawText).toEqual('{/loop}');
         });
 
+        test('simple - with whitespace', () => {
+
+            const text = '{ # loop [opt: "yes"] }{ / loop }';
+            const paragraph = parseXml(`
+                <w:p><w:r><w:t>${text}</w:t></w:r></w:p>
+            `, false);
+
+            const textNode = xml.query.findByPath(paragraph, XmlNodeType.Text, 0, 0, 0);
+            const delimiters: TextNodeDelimiterMark[] = [
+                {
+                    placement: TagPlacement.TextNode,
+                    isOpen: true,
+                    index: 0,
+                    xmlTextNode: textNode
+                },
+                {
+                    placement: TagPlacement.TextNode,
+                    isOpen: false,
+                    index: 22,
+                    xmlTextNode: textNode
+                },
+                {
+                    placement: TagPlacement.TextNode,
+                    isOpen: true,
+                    index: 23,
+                    xmlTextNode: textNode
+                },
+                {
+                    placement: TagPlacement.TextNode,
+                    isOpen: false,
+                    index: 32,
+                    xmlTextNode: textNode
+                }
+            ];
+
+            const parser = createTagParser();
+            const tags = parser.parse(delimiters);
+
+            expect(tags.length).toEqual(2);
+
+            // open tag
+            expect(tags[0].disposition).toEqual(TagDisposition.Open);
+            expect(tags[0].name).toEqual('loop');
+            expect(tags[0].options).toEqual({ opt: 'yes' });
+            expect(tags[0].rawText).toEqual('{ # loop [opt: "yes"] }');
+
+            // close tag
+            expect(tags[1].disposition).toEqual(TagDisposition.Close);
+            expect(tags[1].name).toEqual('loop');
+            expect(tags[1].options).toBeFalsy();
+            expect(tags[1].rawText).toEqual('{ / loop }');
+        });
+
         test('angular parser style with brackets', () => {
 
             const text = '{something[0] [[myOpt: 5]]}';

package/src/compilation/tagUtils.ts

@@ -3,7 +3,7 @@ import { Regex } from "src/utils";
 
 export function tagRegex(delimiters: Delimiters, global: boolean = false): RegExp {
     const tagOptionsPattern = `${Regex.escape(delimiters.tagOptionsStart)}(?<tagOptions>.*?)${Regex.escape(delimiters.tagOptionsEnd)}`;
-    const tagPattern = `${Regex.escape(delimiters.tagStart)}(?<tagName>.*?)(${tagOptionsPattern})?${Regex.escape(delimiters.tagEnd)}`;
+    const tagPattern = `${Regex.escape(delimiters.tagStart)}(?<tagName>.*?)(?:\\s*${tagOptionsPattern})?\\s*${Regex.escape(delimiters.tagEnd)}`;
     const flags = global ? 'gm' : 'm';
     return new RegExp(tagPattern, flags);
 }

package/src/office/officeMarkup.ts

@@ -62,6 +62,10 @@ class Query {
         return node.nodeName === OmlNode.W.RunProperties || node.nodeName === OmlNode.A.RunProperties;
     }
 
+    public isTableNode(node: XmlNode): boolean {
+        return node.nodeName === OmlNode.W.Table;
+    }
+
     public isTableCellNode(node: XmlNode): boolean {
         return node.nodeName === OmlNode.W.TableCell;
     }

package/src/plugins/loop/strategy/loopParagraphStrategy.ts

@@ -1,7 +1,7 @@
 import { TextNodeTag } from "src/compilation";
+import { officeMarkup, OmlNode } from "src/office";
 import { LoopOver, LoopTagOptions } from "src/plugins/loop/loopTagOptions";
-import { officeMarkup } from "src/office";
-import { xml, XmlNode } from "src/xml";
+import { xml, XmlGeneralNode, XmlNode } from "src/xml";
 import { ILoopStrategy, SplitBeforeResult } from "./iLoopStrategy";
 
 export class LoopParagraphStrategy implements ILoopStrategy {
@@ -38,6 +38,11 @@ export class LoopParagraphStrategy implements ILoopStrategy {
             }
         }
 
+        // We cannot leave table cells completely empty, so we track them.
+        // See: http://officeopenxml.com/WPtableCell.php
+        const firstTableCell = officeMarkup.query.containingTableCellNode(firstParagraph);
+        const lastTableCell = officeMarkup.query.containingTableCellNode(lastParagraph);
+
         // Remove old paragraphs - between first and last paragraph.
         xml.modify.removeSiblings(firstParagraph, lastParagraph);
 
@@ -46,5 +51,21 @@ export class LoopParagraphStrategy implements ILoopStrategy {
         if (firstParagraph !== lastParagraph) {
             xml.modify.remove(lastParagraph);
         }
+
+        // Make sure the table cells are not empty (if they exist).
+        if (newParagraphs.length === 0) {
+            this.fillTableCell(firstTableCell);
+            this.fillTableCell(lastTableCell);
+        }
+    }
+
+    private fillTableCell(tableCell: XmlGeneralNode): void {
+        if (
+            tableCell &&
+            !tableCell.childNodes?.find(node => officeMarkup.query.isParagraphNode(node)) &&
+            !tableCell.childNodes?.find(node => officeMarkup.query.isTableNode(node))
+        ) {
+            xml.modify.appendChild(tableCell, xml.create.generalNode(OmlNode.W.Paragraph));
+        }
     }
 }