easy-template-x 7.0.3 → 7.1.1

package/README.md

@@ -615,7 +615,7 @@ Input data:
 {
     "Dont worry be happy": {
         _type: 'rawXml',
-        xml: '<w:sym w:font="Wingdings" w:char="F04A"/>',
+        xml: '<w:sym w:font="Wingdings" w:char="F04A"/>',  // string | string[]
         replaceParagraph: false,  // Optional - should the plugin replace an entire paragraph or just the tag itself
     }
 }
@@ -633,7 +633,7 @@ make it easier to do the actual xml modification.
 
 _To better understand the internal structure of Word documents check out [this excellent source](http://officeopenxml.com/WPcontentOverview.php)._
 
-Example plugin implementation ([source](./src/plugins/rawXml/rawXmlPlugin.ts)):
+Example plugin implementation (this is a simplified example of the [RawXmlPlugin](#raw-xml-plugin) - read the full source [here](./src/plugins/rawXml/rawXmlPlugin.ts)):
 
 ```typescript
 import { officeMarkup, xml } from "easy-template-x";

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

@@ -3757,9 +3757,17 @@ class RawXmlPlugin extends TemplatePlugin {
     }
     const value = data.getScopeData();
     const replaceNode = value?.replaceParagraph ? officeMarkup.query.containingParagraphNode(tag.xmlTextNode) : officeMarkup.query.containingTextNode(tag.xmlTextNode);
-    if (typeof value?.xml === 'string') {
-      const newNode = xml.parser.parse(value.xml);
-      xml.modify.insertBefore(newNode, replaceNode);
+    if (typeof value?.xml === 'string' || Array.isArray(value?.xml) && value.xml.every(item => typeof item === "string")) {
+      // Parse the xml content
+      const xmlContent = Array.isArray(value.xml) ? value.xml.join('') : value.xml;
+      const wrappedXml = `<root>${xmlContent}</root>`;
+      const parsedRoot = xml.parser.parse(wrappedXml);
+
+      // Insert the xml content
+      const children = [...(parsedRoot.childNodes || [])];
+      for (const child of children) {
+        xml.modify.insertBefore(child, replaceNode);
+      }
     }
     if (value?.replaceParagraph) {
       xml.modify.remove(replaceNode);
@@ -3828,7 +3836,7 @@ class TextPlugin extends TemplatePlugin {
     const namespace = runNode.nodeName.split(':')[0];
 
     // First line
-    if (lines[0]) {
+    if (typeof lines[0] === 'string') {
       textNode.textContent = lines[0];
     }
 
@@ -5236,7 +5244,7 @@ class TemplateHandler {
   /**
    * Version number of the `easy-template-x` library.
    */
-  version = "7.0.3" ;
+  version = "7.1.0" ;
   constructor(options) {
     this.options = new TemplateHandlerOptions(options);
     const delimiters = this.options.delimiters;

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

@@ -3755,9 +3755,17 @@ class RawXmlPlugin extends TemplatePlugin {
     }
     const value = data.getScopeData();
     const replaceNode = value?.replaceParagraph ? officeMarkup.query.containingParagraphNode(tag.xmlTextNode) : officeMarkup.query.containingTextNode(tag.xmlTextNode);
-    if (typeof value?.xml === 'string') {
-      const newNode = xml.parser.parse(value.xml);
-      xml.modify.insertBefore(newNode, replaceNode);
+    if (typeof value?.xml === 'string' || Array.isArray(value?.xml) && value.xml.every(item => typeof item === "string")) {
+      // Parse the xml content
+      const xmlContent = Array.isArray(value.xml) ? value.xml.join('') : value.xml;
+      const wrappedXml = `<root>${xmlContent}</root>`;
+      const parsedRoot = xml.parser.parse(wrappedXml);
+
+      // Insert the xml content
+      const children = [...(parsedRoot.childNodes || [])];
+      for (const child of children) {
+        xml.modify.insertBefore(child, replaceNode);
+      }
     }
     if (value?.replaceParagraph) {
       xml.modify.remove(replaceNode);
@@ -3826,7 +3834,7 @@ class TextPlugin extends TemplatePlugin {
     const namespace = runNode.nodeName.split(':')[0];
 
     // First line
-    if (lines[0]) {
+    if (typeof lines[0] === 'string') {
       textNode.textContent = lines[0];
     }
 
@@ -5234,7 +5242,7 @@ class TemplateHandler {
   /**
    * Version number of the `easy-template-x` library.
    */
-  version = "7.0.3" ;
+  version = "7.1.0" ;
   constructor(options) {
     this.options = new TemplateHandlerOptions(options);
     const delimiters = this.options.delimiters;

package/dist/types/plugins/rawXml/rawXmlContent.d.ts

@@ -1,6 +1,6 @@
 import { PluginContent } from '../pluginContent';
 export interface RawXmlContent extends PluginContent {
     _type: 'rawXml';
-    xml: string;
+    xml: string | string[];
     replaceParagraph?: boolean;
 }

package/package.json

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

package/src/plugins/rawXml/rawXmlContent.ts

@@ -2,7 +2,7 @@ import { PluginContent } from '../pluginContent';
 
 export interface RawXmlContent extends PluginContent {
     _type: 'rawXml';
-    xml: string;
+    xml: string | string[];
     /**
      * Replace a part of the document with raw xml content.
      * If set to `true` the plugin will replace the parent paragraph (<w:p>) of

package/src/plugins/rawXml/rawXmlPlugin.ts

@@ -22,9 +22,20 @@ export class RawXmlPlugin extends TemplatePlugin {
             officeMarkup.query.containingParagraphNode(tag.xmlTextNode) :
             officeMarkup.query.containingTextNode(tag.xmlTextNode);
 
-        if (typeof value?.xml === 'string') {
-            const newNode = xml.parser.parse(value.xml);
-            xml.modify.insertBefore(newNode, replaceNode);
+        if (
+            typeof value?.xml === 'string' ||
+            (Array.isArray(value?.xml) && value.xml.every(item => typeof item === "string"))
+        ) {
+            // Parse the xml content
+            const xmlContent = Array.isArray(value.xml) ? value.xml.join('') : value.xml;
+            const wrappedXml = `<root>${xmlContent}</root>`;
+            const parsedRoot = xml.parser.parse(wrappedXml);
+
+            // Insert the xml content
+            const children = [...(parsedRoot.childNodes || [])];
+            for (const child of children) {
+                xml.modify.insertBefore(child, replaceNode);
+            }
         }
 
         if (value?.replaceParagraph) {

package/src/plugins/text/textPlugin.ts

@@ -4,7 +4,7 @@ import { TemplateSyntaxError } from "src/errors";
 import { officeMarkup } from "src/office";
 import { TemplatePlugin } from "src/plugins/templatePlugin";
 import { stringValue } from "src/utils";
-import { xml, XmlNode, XmlTextNode } from "src/xml";
+import { xml, XmlNode } from "src/xml";
 
 export const TEXT_CONTENT_TYPE = 'text';
 
@@ -22,7 +22,7 @@ export class TextPlugin extends TemplatePlugin {
 
         if (tag.placement === TagPlacement.TextNode) {
             this.replaceInTextNode(tag, strValue);
-            return; 
+            return;
         }
 
         if (tag.placement === TagPlacement.Attribute) {
@@ -40,7 +40,7 @@ export class TextPlugin extends TemplatePlugin {
         if (lines.length < 2) {
             this.replaceSingleLine(tag, lines.length ? lines[0] : '');
         } else {
-            this.replaceMultiLine(tag.xmlTextNode, lines);
+            this.replaceMultiLine(tag, lines);
         }
     }
 
@@ -73,15 +73,15 @@ export class TextPlugin extends TemplatePlugin {
         officeMarkup.modify.setSpacePreserveAttribute(wordTextNode);
     }
 
-    private replaceMultiLine(textNode: XmlTextNode, lines: string[]) {
+    private replaceMultiLine(tag: TextNodeTag, lines: string[]) {
 
+        const textNode = tag.xmlTextNode;
         const runNode = officeMarkup.query.containingRunNode(textNode);
         const namespace = runNode.nodeName.split(':')[0];
 
         // First line
-        if (lines[0]) {
-            textNode.textContent = lines[0];
-        }
+        const firstLine = lines[0];
+        textNode.textContent = firstLine;
 
         // Other lines
         for (let i = 1; i < lines.length; i++) {
@@ -96,6 +96,11 @@ export class TextPlugin extends TemplatePlugin {
                 xml.modify.appendChild(runNode, lineNode);
             }
         }
+
+        // Clean up if the original text node is now empty
+        if (!firstLine) {
+            officeMarkup.modify.removeTag(tag);
+        }
     }
 
     private getLineBreak(namespace: string): XmlNode {