easy-template-x 3.2.0 → 3.2.1

package/README.md

@@ -121,7 +121,7 @@ function saveFile(filename, blob) {
 
 ## Live Demo
 
-Checkout this [live demo](https://codesandbox.io/s/easy-template-x-demo-x4ppu?fontsize=14&module=%2Findex.ts) on CodeSandbox 😎
+Checkout this [live demo](https://codesandbox.io/p/sandbox/easy-template-x-demo-x4ppu?file=%2Findex.ts) on CodeSandbox 😎
 
 ## Plugins
 

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

@@ -442,10 +442,11 @@ class XmlDepthTracker {
 let XmlNodeType = /*#__PURE__*/function (XmlNodeType) {
   XmlNodeType["Text"] = "Text";
   XmlNodeType["General"] = "General";
+  XmlNodeType["Comment"] = "Comment";
   return XmlNodeType;
 }({});
 const TEXT_NODE_NAME = '#text'; // see: https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeName
-
+const COMMENT_NODE_NAME = '#comment';
 const XmlNode = {
   //
   // factories
@@ -464,6 +465,13 @@ const XmlNode = {
       nodeName: name
     };
   },
+  createCommentNode(text) {
+    return {
+      nodeType: XmlNodeType.Comment,
+      nodeName: COMMENT_NODE_NAME,
+      commentContent: text
+    };
+  },
   //
   // serialization
   //
@@ -494,6 +502,9 @@ const XmlNode = {
   },
   serialize(node) {
     if (this.isTextNode(node)) return this.encodeValue(node.textContent || '');
+    if (this.isCommentNode(node)) {
+      return `<!-- ${this.encodeValue(node.commentContent || '')} -->`;
+    }
 
     // attributes
     let attributes = '';
@@ -525,25 +536,31 @@ const XmlNode = {
    * The conversion is always deep.
    */
   fromDomNode(domNode) {
+    var _domNode$textContent;
     let xmlNode;
 
     // basic properties
-    if (domNode.nodeType === domNode.TEXT_NODE) {
-      xmlNode = this.createTextNode(domNode.textContent);
-    } else {
-      xmlNode = this.createGeneralNode(domNode.nodeName);
-
-      // attributes
-      if (domNode.nodeType === domNode.ELEMENT_NODE) {
+    switch (domNode.nodeType) {
+      case domNode.TEXT_NODE:
+        xmlNode = this.createTextNode(domNode.textContent);
+        break;
+      case domNode.COMMENT_NODE:
+        xmlNode = this.createCommentNode((_domNode$textContent = domNode.textContent) === null || _domNode$textContent === void 0 ? void 0 : _domNode$textContent.trim());
+        break;
+      case domNode.ELEMENT_NODE:
+        const generalNode = xmlNode = this.createGeneralNode(domNode.nodeName);
         const attributes = domNode.attributes;
         if (attributes) {
-          xmlNode.attributes = {};
+          generalNode.attributes = {};
           for (let i = 0; i < attributes.length; i++) {
             const curAttribute = attributes.item(i);
-            xmlNode.attributes[curAttribute.name] = curAttribute.value;
+            generalNode.attributes[curAttribute.name] = curAttribute.value;
           }
         }
-      }
+        break;
+      default:
+        xmlNode = this.createGeneralNode(domNode.nodeName);
+        break;
     }
 
     // children
@@ -579,6 +596,15 @@ const XmlNode = {
     }
     return false;
   },
+  isCommentNode(node) {
+    if (node.nodeType === XmlNodeType.Comment || node.nodeName === COMMENT_NODE_NAME) {
+      if (!(node.nodeType === XmlNodeType.Comment && node.nodeName === COMMENT_NODE_NAME)) {
+        throw new Error(`Invalid comment node. Type: '${node.nodeType}', Name: '${node.nodeName}'.`);
+      }
+      return true;
+    }
+    return false;
+  },
   cloneNode(node, deep) {
     if (!node) throw new MissingArgumentError("node");
     if (!deep) {
@@ -1930,7 +1956,8 @@ class Docx {
     // find the last section properties
     // see: http://officeopenxml.com/WPsection.php
     const docRoot = await this.mainDocument.xmlRoot();
-    const body = docRoot.childNodes[0];
+    const body = docRoot.childNodes.find(node => node.nodeName == 'w:body');
+    if (body == null) return null;
     const sectionProps = last(body.childNodes.filter(node => node.nodeType === XmlNodeType.General));
     if (sectionProps.nodeName != 'w:sectPr') return null;
 
@@ -2146,7 +2173,10 @@ class DocxParser {
         curWordTextNode = this.firstTextNodeChild(curRunNode);
       }
       while (curWordTextNode) {
-        if (curWordTextNode.nodeName !== DocxParser.TEXT_NODE) continue;
+        if (curWordTextNode.nodeName !== DocxParser.TEXT_NODE) {
+          curWordTextNode = curWordTextNode.nextSibling;
+          continue;
+        }
 
         // move text to first node
         const curXmlTextNode = XmlNode.lastTextChild(curWordTextNode);
@@ -3006,7 +3036,7 @@ class TemplateHandler {
     /**
      * Version number of the `easy-template-x` library.
      */
-    _defineProperty(this, "version", "3.2.0" );
+    _defineProperty(this, "version", "3.2.1" );
     _defineProperty(this, "xmlParser", new XmlParser());
     _defineProperty(this, "docxParser", void 0);
     _defineProperty(this, "compiler", void 0);
@@ -3156,6 +3186,7 @@ class TemplateHandler {
 
 exports.Base64 = Base64;
 exports.Binary = Binary;
+exports.COMMENT_NODE_NAME = COMMENT_NODE_NAME;
 exports.ContentPartType = ContentPartType;
 exports.DelimiterSearcher = DelimiterSearcher;
 exports.Delimiters = Delimiters;

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

@@ -415,10 +415,11 @@ class XmlDepthTracker {
 let XmlNodeType = /*#__PURE__*/function (XmlNodeType) {
   XmlNodeType["Text"] = "Text";
   XmlNodeType["General"] = "General";
+  XmlNodeType["Comment"] = "Comment";
   return XmlNodeType;
 }({});
 const TEXT_NODE_NAME = '#text'; // see: https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeName
-
+const COMMENT_NODE_NAME = '#comment';
 const XmlNode = {
   //
   // factories
@@ -437,6 +438,13 @@ const XmlNode = {
       nodeName: name
     };
   },
+  createCommentNode(text) {
+    return {
+      nodeType: XmlNodeType.Comment,
+      nodeName: COMMENT_NODE_NAME,
+      commentContent: text
+    };
+  },
   //
   // serialization
   //
@@ -467,6 +475,9 @@ const XmlNode = {
   },
   serialize(node) {
     if (this.isTextNode(node)) return this.encodeValue(node.textContent || '');
+    if (this.isCommentNode(node)) {
+      return `<!-- ${this.encodeValue(node.commentContent || '')} -->`;
+    }
 
     // attributes
     let attributes = '';
@@ -498,25 +509,31 @@ const XmlNode = {
    * The conversion is always deep.
    */
   fromDomNode(domNode) {
+    var _domNode$textContent;
     let xmlNode;
 
     // basic properties
-    if (domNode.nodeType === domNode.TEXT_NODE) {
-      xmlNode = this.createTextNode(domNode.textContent);
-    } else {
-      xmlNode = this.createGeneralNode(domNode.nodeName);
-
-      // attributes
-      if (domNode.nodeType === domNode.ELEMENT_NODE) {
+    switch (domNode.nodeType) {
+      case domNode.TEXT_NODE:
+        xmlNode = this.createTextNode(domNode.textContent);
+        break;
+      case domNode.COMMENT_NODE:
+        xmlNode = this.createCommentNode((_domNode$textContent = domNode.textContent) === null || _domNode$textContent === void 0 ? void 0 : _domNode$textContent.trim());
+        break;
+      case domNode.ELEMENT_NODE:
+        const generalNode = xmlNode = this.createGeneralNode(domNode.nodeName);
         const attributes = domNode.attributes;
         if (attributes) {
-          xmlNode.attributes = {};
+          generalNode.attributes = {};
           for (let i = 0; i < attributes.length; i++) {
             const curAttribute = attributes.item(i);
-            xmlNode.attributes[curAttribute.name] = curAttribute.value;
+            generalNode.attributes[curAttribute.name] = curAttribute.value;
           }
         }
-      }
+        break;
+      default:
+        xmlNode = this.createGeneralNode(domNode.nodeName);
+        break;
     }
 
     // children
@@ -552,6 +569,15 @@ const XmlNode = {
     }
     return false;
   },
+  isCommentNode(node) {
+    if (node.nodeType === XmlNodeType.Comment || node.nodeName === COMMENT_NODE_NAME) {
+      if (!(node.nodeType === XmlNodeType.Comment && node.nodeName === COMMENT_NODE_NAME)) {
+        throw new Error(`Invalid comment node. Type: '${node.nodeType}', Name: '${node.nodeName}'.`);
+      }
+      return true;
+    }
+    return false;
+  },
   cloneNode(node, deep) {
     if (!node) throw new MissingArgumentError("node");
     if (!deep) {
@@ -1903,7 +1929,8 @@ class Docx {
     // find the last section properties
     // see: http://officeopenxml.com/WPsection.php
     const docRoot = await this.mainDocument.xmlRoot();
-    const body = docRoot.childNodes[0];
+    const body = docRoot.childNodes.find(node => node.nodeName == 'w:body');
+    if (body == null) return null;
     const sectionProps = last(body.childNodes.filter(node => node.nodeType === XmlNodeType.General));
     if (sectionProps.nodeName != 'w:sectPr') return null;
 
@@ -2119,7 +2146,10 @@ class DocxParser {
         curWordTextNode = this.firstTextNodeChild(curRunNode);
       }
       while (curWordTextNode) {
-        if (curWordTextNode.nodeName !== DocxParser.TEXT_NODE) continue;
+        if (curWordTextNode.nodeName !== DocxParser.TEXT_NODE) {
+          curWordTextNode = curWordTextNode.nextSibling;
+          continue;
+        }
 
         // move text to first node
         const curXmlTextNode = XmlNode.lastTextChild(curWordTextNode);
@@ -2979,7 +3009,7 @@ class TemplateHandler {
     /**
      * Version number of the `easy-template-x` library.
      */
-    _defineProperty(this, "version", "3.2.0" );
+    _defineProperty(this, "version", "3.2.1" );
     _defineProperty(this, "xmlParser", new XmlParser());
     _defineProperty(this, "docxParser", void 0);
     _defineProperty(this, "compiler", void 0);
@@ -3127,4 +3157,4 @@ class TemplateHandler {
   }
 }
 
-export { Base64, Binary, ContentPartType, DelimiterSearcher, Delimiters, Docx, DocxParser, ImagePlugin, LOOP_CONTENT_TYPE, LinkPlugin, LoopPlugin, MalformedFileError, MaxXmlDepthError, MimeType, MimeTypeHelper, MissingArgumentError, MissingCloseDelimiterError, MissingStartDelimiterError, Path, PluginContent, RawXmlPlugin, Regex, ScopeData, TEXT_CONTENT_TYPE, TEXT_NODE_NAME, TagDisposition, TagParser, TemplateCompiler, TemplateExtension, TemplateHandler, TemplateHandlerOptions, TemplatePlugin, TextPlugin, UnclosedTagError, UnidentifiedFileTypeError, UnknownContentTypeError, UnopenedTagError, UnsupportedFileTypeError, XmlDepthTracker, XmlNode, XmlNodeType, XmlParser, XmlPart, Zip, ZipObject, createDefaultPlugins, first, inheritsFrom, isNumber, isPromiseLike, last, pushMany, sha1, stringValue, toDictionary };
+export { Base64, Binary, COMMENT_NODE_NAME, ContentPartType, DelimiterSearcher, Delimiters, Docx, DocxParser, ImagePlugin, LOOP_CONTENT_TYPE, LinkPlugin, LoopPlugin, MalformedFileError, MaxXmlDepthError, MimeType, MimeTypeHelper, MissingArgumentError, MissingCloseDelimiterError, MissingStartDelimiterError, Path, PluginContent, RawXmlPlugin, Regex, ScopeData, TEXT_CONTENT_TYPE, TEXT_NODE_NAME, TagDisposition, TagParser, TemplateCompiler, TemplateExtension, TemplateHandler, TemplateHandlerOptions, TemplatePlugin, TextPlugin, UnclosedTagError, UnidentifiedFileTypeError, UnknownContentTypeError, UnopenedTagError, UnsupportedFileTypeError, XmlDepthTracker, XmlNode, XmlNodeType, XmlParser, XmlPart, Zip, ZipObject, createDefaultPlugins, first, inheritsFrom, isNumber, isPromiseLike, last, pushMany, sha1, stringValue, toDictionary };

package/dist/types/xml/xmlNode.d.ts

@@ -1,9 +1,10 @@
 import { IMap } from '../types';
 export declare enum XmlNodeType {
     Text = "Text",
-    General = "General"
+    General = "General",
+    Comment = "Comment"
 }
-export declare type XmlNode = XmlTextNode | XmlGeneralNode;
+export declare type XmlNode = XmlTextNode | XmlGeneralNode | XmlCommentNode;
 export interface XmlNodeBase {
     nodeType: XmlNodeType;
     nodeName: string;
@@ -12,11 +13,17 @@ export interface XmlNodeBase {
     nextSibling?: XmlNode;
 }
 export declare const TEXT_NODE_NAME = "#text";
+export declare const COMMENT_NODE_NAME = "#comment";
 export interface XmlTextNode extends XmlNodeBase {
     nodeType: XmlNodeType.Text;
     nodeName: typeof TEXT_NODE_NAME;
     textContent: string;
 }
+export interface XmlCommentNode extends XmlNodeBase {
+    nodeType: XmlNodeType.Comment;
+    nodeName: typeof COMMENT_NODE_NAME;
+    commentContent: string;
+}
 export interface XmlGeneralNode extends XmlNodeBase {
     nodeType: XmlNodeType.General;
     attributes?: IMap<string>;
@@ -24,10 +31,12 @@ export interface XmlGeneralNode extends XmlNodeBase {
 export declare const XmlNode: {
     createTextNode(text?: string): XmlTextNode;
     createGeneralNode(name: string): XmlGeneralNode;
+    createCommentNode(text?: string): XmlCommentNode;
     encodeValue(str: string): string;
     serialize(node: XmlNode): string;
     fromDomNode(domNode: Node): XmlNode;
     isTextNode(node: XmlNode): node is XmlTextNode;
+    isCommentNode(node: XmlNode): node is XmlCommentNode;
     cloneNode<T extends XmlNode>(node: T, deep: boolean): T;
     insertBefore(newNode: XmlNode, referenceNode: XmlNode): void;
     insertAfter(newNode: XmlNode, referenceNode: XmlNode): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easy-template-x",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "Generate docx documents from templates, in Node or in the browser.",
   "keywords": [
     "docx",
@@ -64,6 +64,7 @@
     "babel-plugin-ts-nameof": "4.2.1",
     "eslint": "8.19.0",
     "jest": "28.1.2",
+    "jest-html-reporters": "3.1.7",
     "jest-junit": "14.0.0",
     "lorem-ipsum": "2.0.8",
     "rimraf": "3.0.2",

package/src/office/docx.ts

@@ -114,7 +114,10 @@ export class Docx {
         // find the last section properties
         // see: http://officeopenxml.com/WPsection.php
         const docRoot = await this.mainDocument.xmlRoot();
-        const body = docRoot.childNodes[0];
+        const body = docRoot.childNodes.find(node => node.nodeName == 'w:body');
+        if (body == null)
+            return null;
+
         const sectionProps = last(body.childNodes.filter(node => node.nodeType === XmlNodeType.General));
         if (sectionProps.nodeName != 'w:sectPr')
             return null;

package/src/office/docxParser.ts

@@ -208,8 +208,10 @@ export class DocxParser {
             }
             while (curWordTextNode) {
 
-                if (curWordTextNode.nodeName !== DocxParser.TEXT_NODE)
+                if (curWordTextNode.nodeName !== DocxParser.TEXT_NODE) {
+                    curWordTextNode = curWordTextNode.nextSibling;
                     continue;
+                }
 
                 // move text to first node
                 const curXmlTextNode = XmlNode.lastTextChild(curWordTextNode);

package/src/xml/xmlNode.ts

@@ -4,10 +4,11 @@ import { last } from '../utils';
 
 export enum XmlNodeType {
     Text = "Text",
-    General = "General"
+    General = "General",
+    Comment = "Comment",
 }
 
-export type XmlNode = XmlTextNode | XmlGeneralNode;
+export type XmlNode = XmlTextNode | XmlGeneralNode | XmlCommentNode;
 
 export interface XmlNodeBase {
     nodeType: XmlNodeType;
@@ -18,6 +19,7 @@ export interface XmlNodeBase {
 }
 
 export const TEXT_NODE_NAME = '#text'; // see: https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeName
+export const COMMENT_NODE_NAME = '#comment';
 
 export interface XmlTextNode extends XmlNodeBase {
     nodeType: XmlNodeType.Text;
@@ -25,6 +27,12 @@ export interface XmlTextNode extends XmlNodeBase {
     textContent: string;
 }
 
+export interface XmlCommentNode extends XmlNodeBase {
+    nodeType: XmlNodeType.Comment;
+    nodeName: typeof COMMENT_NODE_NAME;
+    commentContent: string;
+}
+
 export interface XmlGeneralNode extends XmlNodeBase {
     nodeType: XmlNodeType.General;
     attributes?: IMap<string>;
@@ -51,6 +59,14 @@ export const XmlNode = {
         };
     },
 
+    createCommentNode(text?: string): XmlCommentNode {
+        return {
+            nodeType: XmlNodeType.Comment,
+            nodeName: COMMENT_NODE_NAME,
+            commentContent: text
+        };
+    },
+
     //
     // serialization
     //
@@ -82,6 +98,10 @@ export const XmlNode = {
         if (this.isTextNode(node))
             return this.encodeValue(node.textContent || '');
 
+        if (this.isCommentNode(node)) {
+            return `<!-- ${this.encodeValue(node.commentContent || '')} -->`;
+        }
+
         // attributes
         let attributes = '';
         if (node.attributes) {
@@ -125,25 +145,27 @@ export const XmlNode = {
         let xmlNode: XmlNode;
 
         // basic properties
-        if (domNode.nodeType === domNode.TEXT_NODE) {
-
-            xmlNode = this.createTextNode(domNode.textContent);
-
-        } else {
-
-            xmlNode = this.createGeneralNode(domNode.nodeName);
-
-            // attributes
-            if (domNode.nodeType === domNode.ELEMENT_NODE) {
+        switch (domNode.nodeType) {
+            case domNode.TEXT_NODE:
+                xmlNode = this.createTextNode(domNode.textContent);
+                break;
+            case domNode.COMMENT_NODE:
+                xmlNode = this.createCommentNode(domNode.textContent?.trim());
+                break;
+            case domNode.ELEMENT_NODE:
+                const generalNode = xmlNode = this.createGeneralNode(domNode.nodeName);
                 const attributes = (domNode as Element).attributes;
                 if (attributes) {
-                    (xmlNode as XmlGeneralNode).attributes = {};
+                    generalNode.attributes = {};
                     for (let i = 0; i < attributes.length; i++) {
                         const curAttribute = attributes.item(i);
-                        (xmlNode as XmlGeneralNode).attributes[curAttribute.name] = curAttribute.value;
+                        generalNode.attributes[curAttribute.name] = curAttribute.value;
                     }
                 }
-            }
+                break;
+            default:
+                xmlNode = this.createGeneralNode(domNode.nodeName);
+                break;
         }
 
         // children
@@ -183,6 +205,16 @@ export const XmlNode = {
         return false;
     },
 
+    isCommentNode(node: XmlNode): node is XmlCommentNode {
+        if (node.nodeType === XmlNodeType.Comment || node.nodeName === COMMENT_NODE_NAME) {
+            if (!(node.nodeType === XmlNodeType.Comment && node.nodeName === COMMENT_NODE_NAME)) {
+                throw new Error(`Invalid comment node. Type: '${node.nodeType}', Name: '${node.nodeName}'.`);
+            }
+            return true;
+        }
+        return false;
+    },
+
     cloneNode<T extends XmlNode>(node: T, deep: boolean): T {
         if (!node)
             throw new MissingArgumentError(nameof(node));