easy-template-x 6.2.1 → 6.2.3

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

@@ -202,8 +202,16 @@ function isNumber(value) {
 class Path {
   static getFilename(path) {
     const lastSlashIndex = path.lastIndexOf('/');
-    return path.substr(lastSlashIndex + 1);
+    return path.substring(lastSlashIndex + 1);
   }
+
+  /**
+   * Get the directory of a path. 
+   * Exclude the last slash.
+   * 
+   * Example:
+   * /folder/subfolder/file.txt -> /folder/subfolder
+   */
   static getDirectory(path) {
     const lastSlashIndex = path.lastIndexOf('/');
     return path.substring(0, lastSlashIndex);
@@ -404,6 +412,10 @@ function stringValue(val) {
 function normalizeDoubleQuotes(text) {
   return text.replace(nonStandardDoubleQuotesRegex, standardDoubleQuotes);
 }
+function countOccurrences(text, substring) {
+  // https://stackoverflow.com/questions/4009756/how-to-count-string-occurrence-in-string
+  return (text.match(new RegExp(substring, 'g')) || []).length;
+}
 
 class JsZipHelper {
   static toJsZipOutputType(binaryOrType) {
@@ -457,6 +469,9 @@ class Zip {
     this.binaryFormat = binaryFormat;
   }
   getFile(path) {
+    if (path && path.startsWith('/')) {
+      path = path.substring(1);
+    }
     const internalZipObject = this.zip.files[path];
     if (!internalZipObject) return null;
     return new ZipObject(internalZipObject, this.binaryFormat);
@@ -868,7 +883,7 @@ let Modify$1 = class Modify {
   insertBefore(newNode, referenceNode) {
     if (!newNode) throw new InternalArgumentMissingError("newNode");
     if (!referenceNode) throw new InternalArgumentMissingError("referenceNode");
-    if (!referenceNode.parentNode) throw new Error(`'${"referenceNode"}' has no parent`);
+    if (!referenceNode.parentNode) throw new Error(`'referenceNode' has no parent`);
     const childNodes = referenceNode.parentNode.childNodes;
     const beforeNodeIndex = childNodes.indexOf(referenceNode);
     xml.modify.insertChild(referenceNode.parentNode, newNode, beforeNodeIndex);
@@ -883,7 +898,7 @@ let Modify$1 = class Modify {
   insertAfter(newNode, referenceNode) {
     if (!newNode) throw new InternalArgumentMissingError("newNode");
     if (!referenceNode) throw new InternalArgumentMissingError("referenceNode");
-    if (!referenceNode.parentNode) throw new Error(`'${"referenceNode"}' has no parent`);
+    if (!referenceNode.parentNode) throw new Error(`'referenceNode' has no parent`);
     const childNodes = referenceNode.parentNode.childNodes;
     const referenceNodeIndex = childNodes.indexOf(referenceNode);
     xml.modify.insertChild(referenceNode.parentNode, newNode, referenceNodeIndex + 1);
@@ -1020,7 +1035,7 @@ let Modify$1 = class Modify {
    * `false` then the original child node is the first child of `right`.
    */
   splitByChild(parent, child, removeChild) {
-    if (child.parentNode != parent) throw new Error(`Node '${"child"}' is not a direct child of '${"parent"}'.`);
+    if (child.parentNode != parent) throw new Error(`Node 'child' is not a direct child of 'parent'.`);
 
     // create childless clone 'left'
     const left = xml.create.cloneNode(parent, false);
@@ -1128,20 +1143,35 @@ const RelType = Object.freeze({
   Table: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/table'
 });
 class Relationship {
-  static fromXml(xml) {
+  static fromXml(partDir, xml) {
     return new Relationship({
       id: xml.attributes?.['Id'],
       type: xml.attributes?.['Type'],
-      target: Relationship.normalizeRelTarget(xml.attributes?.['Target']),
+      target: Relationship.normalizeRelTarget(partDir, xml.attributes?.['Target']),
       targetMode: xml.attributes?.['TargetMode']
     });
   }
-  static normalizeRelTarget(target) {
+  static normalizeRelTarget(partDir, target) {
     if (!target) {
       return target;
     }
+
+    // Remove leading slashes from input
+    if (partDir.startsWith('/')) {
+      partDir = partDir.substring(1);
+    }
+    if (target.startsWith('/')) {
+      target = target.substring(1);
+    }
+
+    // Convert target to relative path
+    if (target.startsWith(partDir)) {
+      target = target.substring(partDir.length);
+    }
+
+    // Remove leading slashes from output
     if (target.startsWith('/')) {
-      return target.substring(1);
+      target = target.substring(1);
     }
     return target;
   }
@@ -1152,11 +1182,11 @@ class Relationship {
     const node = xml.create.generalNode('Relationship');
     node.attributes = {};
 
-    // set only non-empty attributes
+    // Set only non-empty attributes
     for (const propKey of Object.keys(this)) {
       const value = this[propKey];
       if (value && typeof value === 'string') {
-        const attrName = propKey[0].toUpperCase() + propKey.substr(1);
+        const attrName = propKey[0].toUpperCase() + propKey.substring(1);
         node.attributes[attrName] = value;
       }
     }
@@ -1215,13 +1245,12 @@ class ContentTypesFile {
     // Parse the content types file
     await this.parseContentTypesFile();
 
-    // Mime type already exists
-    if (this.contentTypes[mime]) return;
-
     // Extension already exists
-    // Unfortunately, this can happen in real life so we need to handle it.
+    //
+    // Multiple extensions may map to the same mime type, but a single
+    // extension must only map to one mime type.
     const extension = MimeTypeHelper.getDefaultExtension(mime);
-    if (Object.values(this.contentTypes).includes(extension)) return;
+    if (this.contentTypes[extension]) return;
 
     // Add new node
     const typeNode = xml.create.generalNode('Default');
@@ -1233,11 +1262,11 @@ class ContentTypesFile {
 
     // Update state
     this.addedNew = true;
-    this.contentTypes[mime] = extension;
+    this.contentTypes[extension] = mime;
   }
-  async count() {
+  async xmlString() {
     await this.parseContentTypesFile();
-    return this.root.childNodes.filter(node => !xml.query.isTextNode(node)).length;
+    return xml.parser.serializeFile(this.root);
   }
 
   /**
@@ -1266,7 +1295,7 @@ class ContentTypesFile {
       if (!contentTypeAttribute) continue;
       const extensionAttribute = genNode.attributes['Extension'];
       if (!extensionAttribute) continue;
-      this.contentTypes[contentTypeAttribute] = extensionAttribute;
+      this.contentTypes[extensionAttribute] = contentTypeAttribute;
     }
   }
 }
@@ -1286,39 +1315,38 @@ class MediaFiles {
    * Returns the media file path.
    */
   async add(mediaFile, mime) {
-    // check if already added
+    // Check if already added
     if (this.files.has(mediaFile)) return this.files.get(mediaFile);
 
-    // hash existing media files
+    // Hash existing media files
     await this.hashMediaFiles();
 
-    // hash the new file
+    // Hash the new file
     // Note: Even though hashing the base64 string may seem inefficient
     // (requires extra step in some cases) in practice it is significantly
     // faster than hashing a 'binarystring'.
     const base64 = await Binary.toBase64(mediaFile);
     const hash = sha1(base64);
 
-    // check if file already exists
-    // note: this can be optimized by keeping both mapping by filename as well as by hash
+    // Check if file already exists
+    // Note: this can be optimized by keeping both mapping by filename as well as by hash
     let path = Object.keys(this.hashes).find(p => this.hashes[p] === hash);
     if (path) return path;
 
-    // generate unique media file name
+    // Generate unique media file name
+    const baseFilename = this.baseFilename(mime);
     const extension = MimeTypeHelper.getDefaultExtension(mime);
     do {
       this.nextFileId++;
-      path = `${MediaFiles.mediaDir}/media${this.nextFileId}.${extension}`;
+      path = `${MediaFiles.mediaDir}/${baseFilename}${this.nextFileId}.${extension}`;
     } while (this.hashes[path]);
 
-    // add media to zip
-    await this.zip.setFile(path, mediaFile);
+    // Add media to zip
+    this.zip.setFile(path, mediaFile);
 
-    // add media to our lookups
+    // Add media to our lookups
     this.hashes[path] = hash;
     this.files.set(mediaFile, path);
-
-    // return
     return path;
   }
   async count() {
@@ -1334,9 +1362,15 @@ class MediaFiles {
       if (!filename) continue;
       const fileData = await this.zip.getFile(path).getContentBase64();
       const fileHash = sha1(fileData);
-      this.hashes[filename] = fileHash;
+      this.hashes[path] = fileHash;
     }
   }
+  baseFilename(mime) {
+    // Naive heuristic.
+    // May need to be modified if we're going to support more mime types.
+    const parts = mime.split('/');
+    return parts[0];
+  }
 }
 
 /**
@@ -1357,20 +1391,20 @@ class RelsFile {
    * Returns the rel ID.
    */
   async add(relTarget, relType, relTargetMode) {
-    // if relTarget is an internal file it should be relative to the part dir
+    // If relTarget is an internal file it should be relative to the part dir
     if (this.partDir && relTarget.startsWith(this.partDir)) {
-      relTarget = relTarget.substr(this.partDir.length + 1);
+      relTarget = relTarget.substring(this.partDir.length + 1);
     }
 
-    // parse rels file
+    // Parse rels file
     await this.parseRelsFile();
 
-    // already exists?
+    // Already exists?
     const relTargetKey = this.getRelTargetKey(relType, relTarget);
     let relId = this.relTargets[relTargetKey];
     if (relId) return relId;
 
-    // create rel node
+    // Create rel node
     relId = this.getNextRelId();
     const rel = new Relationship({
       id: relId,
@@ -1379,11 +1413,11 @@ class RelsFile {
       targetMode: relTargetMode
     });
 
-    // update lookups
+    // Update lookups
     this.rels[relId] = rel;
     this.relTargets[relTargetKey] = relId;
 
-    // return
+    // Return
     return relId;
   }
   async list() {
@@ -1402,20 +1436,20 @@ class RelsFile {
    * Called automatically by the holding `Docx` before exporting.
    */
   async save() {
-    // not change - no need to save
+    // Not change - no need to save
     if (!this.rels) return;
 
-    // create rels xml
+    // Create rels xml
     const root = this.createRootNode();
     root.childNodes = Object.values(this.rels).map(rel => rel.toXml());
 
-    // serialize and save
+    // Serialize and save
     const xmlContent = xml.parser.serializeFile(root);
     this.zip.setFile(this.relsFilePath, xmlContent);
   }
 
   //
-  // private methods
+  // Private methods
   //
 
   getNextRelId() {
@@ -1427,10 +1461,10 @@ class RelsFile {
     return relId;
   }
   async parseRelsFile() {
-    // already parsed
+    // Already parsed
     if (this.rels) return;
 
-    // parse xml
+    // Parse xml
     let root;
     const relsFile = this.zip.getFile(this.relsFilePath);
     if (relsFile) {
@@ -1440,24 +1474,23 @@ class RelsFile {
       root = this.createRootNode();
     }
 
-    // parse relationship nodes
+    // Parse relationship nodes
     this.rels = {};
     this.relTargets = {};
     for (const relNode of root.childNodes) {
-      const attributes = relNode.attributes;
+      const genRelNode = relNode;
+      const attributes = genRelNode.attributes;
       if (!attributes) continue;
       const idAttr = attributes['Id'];
       if (!idAttr) continue;
 
-      // store rel
-      const rel = Relationship.fromXml(relNode);
+      // Store rel
+      const rel = Relationship.fromXml(this.partDir, genRelNode);
       this.rels[idAttr] = rel;
 
-      // create rel target lookup
-      const typeAttr = attributes['Type'];
-      const targetAttr = Relationship.normalizeRelTarget(attributes['Target']);
-      if (typeAttr && targetAttr) {
-        const relTargetKey = this.getRelTargetKey(typeAttr, targetAttr);
+      // Create rel target lookup
+      if (rel.type && rel.target) {
+        const relTargetKey = this.getRelTargetKey(rel.type, rel.target);
         this.relTargets[relTargetKey] = idAttr;
       }
     }
@@ -1513,7 +1546,7 @@ class OpenXmlPart {
   async getText() {
     const xmlDocument = await this.xmlRoot();
 
-    // ugly but good enough...
+    // Ugly but good enough...
     const xmlString = xml.parser.serializeFile(xmlDocument);
     const domDocument = xml.parser.domParse(xmlString);
     return domDocument.documentElement.textContent;
@@ -1828,7 +1861,7 @@ class Query {
    */
   containingTextNode(node) {
     if (!node) return null;
-    if (!xml.query.isTextNode(node)) throw new Error(`'Invalid argument ${"node"}. Expected a XmlTextNode.`);
+    if (!xml.query.isTextNode(node)) throw new Error(`'Invalid argument node. Expected a XmlTextNode.`);
     return xml.query.findParent(node, officeMarkup.query.isTextNode);
   }
 
@@ -1945,7 +1978,7 @@ class Modify {
   splitParagraphByTextNode(paragraph, textNode, removeTextNode) {
     // input validation
     const containingParagraph = officeMarkup.query.containingParagraphNode(textNode);
-    if (containingParagraph != paragraph) throw new Error(`Node '${"textNode"}' is not a descendant of '${"paragraph"}'.`);
+    if (containingParagraph != paragraph) throw new Error(`Node 'textNode' is not a contained in the specified paragraph.`);
     const runNode = officeMarkup.query.containingRunNode(textNode);
     const wordTextNode = officeMarkup.query.containingTextNode(textNode);
 
@@ -2603,19 +2636,17 @@ class ImagePlugin extends TemplatePlugin {
     if (!context.pluginContext[this.contentType]) {
       context.pluginContext[this.contentType] = {};
     }
-    if (!context.pluginContext[this.contentType]) {
-      context.pluginContext[this.contentType] = {};
-    }
     const pluginContext = context.pluginContext[this.contentType];
     if (!pluginContext.lastDrawingObjectId) {
       pluginContext.lastDrawingObjectId = {};
     }
     const lastIdMap = pluginContext.lastDrawingObjectId;
+    const lastIdKey = context.currentPart.path;
 
     // Get next image ID if already initialized.
-    if (lastIdMap[context.currentPart.path]) {
-      lastIdMap[context.currentPart.path]++;
-      return lastIdMap[context.currentPart.path];
+    if (lastIdMap[lastIdKey]) {
+      lastIdMap[lastIdKey]++;
+      return lastIdMap[lastIdKey];
     }
 
     // Init next image ID.
@@ -2632,8 +2663,8 @@ class ImagePlugin extends TemplatePlugin {
     // Start counting from the current max
     const ids = docProps.map(prop => parseInt(prop.attributes.id)).filter(isNumber);
     const maxId = Math.max(...ids, 0);
-    lastIdMap[context.currentPart.path] = maxId + 1;
-    return lastIdMap[context.currentPart.path];
+    lastIdMap[lastIdKey] = maxId + 1;
+    return lastIdMap[lastIdKey];
   }
   createMarkup(imageId, relId, content) {
     // http://officeopenxml.com/drwPicInline.php
@@ -4648,7 +4679,7 @@ class Delimiters {
   constructor(initial) {
     Object.assign(this, initial);
     this.encodeAndValidate();
-    if (this.containerTagOpen === this.containerTagClose) throw new Error(`${"containerTagOpen"} can not be equal to ${"containerTagClose"}`);
+    if (this.containerTagOpen === this.containerTagClose) throw new Error(`containerTagOpen can not be equal to containerTagClose`);
   }
   encodeAndValidate() {
     const keys = ['tagStart', 'tagEnd', 'containerTagOpen', 'containerTagClose'];
@@ -4691,12 +4722,12 @@ class TemplateHandler {
   /**
    * Version number of the `easy-template-x` library.
    */
-  version = "6.2.1" ;
+  version = "6.2.3" ;
   constructor(options) {
     this.options = new TemplateHandlerOptions(options);
 
     //
-    // this is the library's composition root
+    // This is the library's composition root
     //
 
     const delimiterSearcher = new DelimiterSearcher();
@@ -4727,14 +4758,14 @@ class TemplateHandler {
   }
 
   //
-  // public methods
+  // Public methods
   //
 
   async process(templateFile, data) {
-    // load the docx file
+    // Load the docx file
     const docx = await Docx.load(templateFile);
 
-    // prepare context
+    // Prepare context
     const scopeData = new ScopeData(data);
     scopeData.scopeDataResolver = this.options.scopeDataResolver;
     const context = {
@@ -4749,18 +4780,18 @@ class TemplateHandler {
     for (const part of contentParts) {
       context.currentPart = part;
 
-      // extensions - before compilation
+      // Extensions - before compilation
       await this.callExtensions(this.options.extensions?.beforeCompilation, scopeData, context);
 
-      // compilation (do replacements)
+      // Compilation (do replacements)
       const xmlRoot = await part.xmlRoot();
       await this.compiler.compile(xmlRoot, scopeData, context);
 
-      // extensions - after compilation
+      // Extensions - after compilation
       await this.callExtensions(this.options.extensions?.afterCompilation, scopeData, context);
     }
 
-    // export the result
+    // Export the result
     return docx.export();
   }
   async parseTags(templateFile) {
@@ -4822,7 +4853,7 @@ class TemplateHandler {
   }
 
   //
-  // private methods
+  // Private methods
   //
 
   async callExtensions(extensions, scopeData, context) {
@@ -4836,6 +4867,7 @@ class TemplateHandler {
 exports.Base64 = Base64;
 exports.Binary = Binary;
 exports.COMMENT_NODE_NAME = COMMENT_NODE_NAME;
+exports.ChartPlugin = ChartPlugin;
 exports.DelimiterSearcher = DelimiterSearcher;
 exports.Delimiters = Delimiters;
 exports.Docx = Docx;
@@ -4887,6 +4919,7 @@ exports.XmlTreeIterator = XmlTreeIterator;
 exports.XmlUtils = XmlUtils;
 exports.Zip = Zip;
 exports.ZipObject = ZipObject;
+exports.countOccurrences = countOccurrences;
 exports.createDefaultPlugins = createDefaultPlugins;
 exports.first = first;
 exports.inheritsFrom = inheritsFrom;