easy-template-x 6.2.1 → 6.2.2

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

@@ -404,6 +404,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) {
@@ -1215,13 +1219,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 +1236,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 +1269,7 @@ class ContentTypesFile {
       if (!contentTypeAttribute) continue;
       const extensionAttribute = genNode.attributes['Extension'];
       if (!extensionAttribute) continue;
-      this.contentTypes[contentTypeAttribute] = extensionAttribute;
+      this.contentTypes[extensionAttribute] = contentTypeAttribute;
     }
   }
 }
@@ -1286,39 +1289,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 +1336,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];
+  }
 }
 
 /**
@@ -2603,19 +2611,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 +2638,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
@@ -4691,7 +4697,7 @@ class TemplateHandler {
   /**
    * Version number of the `easy-template-x` library.
    */
-  version = "6.2.1" ;
+  version = "6.2.2" ;
   constructor(options) {
     this.options = new TemplateHandlerOptions(options);
 
@@ -4836,6 +4842,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 +4894,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;

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

@@ -402,6 +402,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) {
@@ -1213,13 +1217,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');
@@ -1231,11 +1234,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);
   }
 
   /**
@@ -1264,7 +1267,7 @@ class ContentTypesFile {
       if (!contentTypeAttribute) continue;
       const extensionAttribute = genNode.attributes['Extension'];
       if (!extensionAttribute) continue;
-      this.contentTypes[contentTypeAttribute] = extensionAttribute;
+      this.contentTypes[extensionAttribute] = contentTypeAttribute;
     }
   }
 }
@@ -1284,39 +1287,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() {
@@ -1332,9 +1334,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];
+  }
 }
 
 /**
@@ -2601,19 +2609,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.
@@ -2630,8 +2636,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
@@ -4689,7 +4695,7 @@ class TemplateHandler {
   /**
    * Version number of the `easy-template-x` library.
    */
-  version = "6.2.1" ;
+  version = "6.2.2" ;
   constructor(options) {
     this.options = new TemplateHandlerOptions(options);
 
@@ -4831,4 +4837,4 @@ class TemplateHandler {
   }
 }
 
-export { Base64, Binary, COMMENT_NODE_NAME, DelimiterSearcher, Delimiters, Docx, ImagePlugin, InternalArgumentMissingError, InternalError, LOOP_CONTENT_TYPE, LinkPlugin, LoopPlugin, MalformedFileError, MaxXmlDepthError, MimeType, MimeTypeHelper, MissingCloseDelimiterError, MissingStartDelimiterError, OfficeMarkup, OmlAttribute, OmlNode, OpenXmlPart, Path, PluginContent, RawXmlPlugin, Regex, RelType, Relationship, ScopeData, TEXT_CONTENT_TYPE, TEXT_NODE_NAME, TagDisposition, TagOptionsParseError, TagParser, TemplateCompiler, TemplateDataError, TemplateExtension, TemplateHandler, TemplateHandlerOptions, TemplatePlugin, TemplateSyntaxError, TextPlugin, UnclosedTagError, UnidentifiedFileTypeError, UnknownContentTypeError, UnopenedTagError, UnsupportedFileTypeError, Xlsx, XmlDepthTracker, XmlNodeType, XmlTreeIterator, XmlUtils, Zip, ZipObject, createDefaultPlugins, first, inheritsFrom, isNumber, isPromiseLike, last, normalizeDoubleQuotes, officeMarkup, pushMany, sha1, stringValue, toDictionary, xml };
+export { Base64, Binary, COMMENT_NODE_NAME, ChartPlugin, DelimiterSearcher, Delimiters, Docx, ImagePlugin, InternalArgumentMissingError, InternalError, LOOP_CONTENT_TYPE, LinkPlugin, LoopPlugin, MalformedFileError, MaxXmlDepthError, MimeType, MimeTypeHelper, MissingCloseDelimiterError, MissingStartDelimiterError, OfficeMarkup, OmlAttribute, OmlNode, OpenXmlPart, Path, PluginContent, RawXmlPlugin, Regex, RelType, Relationship, ScopeData, TEXT_CONTENT_TYPE, TEXT_NODE_NAME, TagDisposition, TagOptionsParseError, TagParser, TemplateCompiler, TemplateDataError, TemplateExtension, TemplateHandler, TemplateHandlerOptions, TemplatePlugin, TemplateSyntaxError, TextPlugin, UnclosedTagError, UnidentifiedFileTypeError, UnknownContentTypeError, UnopenedTagError, UnsupportedFileTypeError, Xlsx, XmlDepthTracker, XmlNodeType, XmlTreeIterator, XmlUtils, Zip, ZipObject, countOccurrences, createDefaultPlugins, first, inheritsFrom, isNumber, isPromiseLike, last, normalizeDoubleQuotes, officeMarkup, pushMany, sha1, stringValue, toDictionary, xml };

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

@@ -8,7 +8,7 @@ export declare class ContentTypesFile {
     private readonly zip;
     constructor(zip: Zip);
     ensureContentType(mime: MimeType): Promise<void>;
-    count(): Promise<number>;
+    xmlString(): Promise<string>;
     save(): Promise<void>;
     private parseContentTypesFile;
 }

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

@@ -11,4 +11,5 @@ export declare class MediaFiles {
     add(mediaFile: Binary, mime: MimeType): Promise<string>;
     count(): Promise<number>;
     private hashMediaFiles;
+    private baseFilename;
 }

package/dist/types/plugins/index.d.ts

@@ -3,6 +3,7 @@ export * from './link';
 export * from './loop';
 export * from './rawXml';
 export * from './text';
+export * from "./chart";
 export * from './defaultPlugins';
 export * from './pluginContent';
 export * from './templatePlugin';

package/dist/types/utils/txt.d.ts

@@ -1,2 +1,3 @@
 export declare function stringValue(val: unknown): string;
 export declare function normalizeDoubleQuotes(text: string): string;
+export declare function countOccurrences(text: string, substring: string): number;

package/package.json

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

package/src/office/contentTypesFile.ts

@@ -13,7 +13,7 @@ export class ContentTypesFile {
 
     private root: XmlNode;
 
-    private contentTypes: Partial<Record<MimeType, string>>;
+    private contentTypes: Partial<Record<string, MimeType>>;
 
     private readonly zip: Zip;
 
@@ -26,14 +26,12 @@ export 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))
+        if (this.contentTypes[extension])
             return;
 
         // Add new node
@@ -46,12 +44,12 @@ export class ContentTypesFile {
 
         // Update state
         this.addedNew = true;
-        this.contentTypes[mime] = extension;
+        this.contentTypes[extension] = mime;
     }
 
-    public async count(): Promise<number> {
+    public async xmlString(): Promise<string> {
         await this.parseContentTypesFile();
-        return this.root.childNodes.filter(node => !xml.query.isTextNode(node)).length;
+        return xml.parser.serializeFile(this.root);
     }
 
     /**
@@ -92,7 +90,7 @@ export class ContentTypesFile {
             if (!extensionAttribute)
                 continue;
 
-            this.contentTypes[contentTypeAttribute] = extensionAttribute;
+            this.contentTypes[extensionAttribute] = contentTypeAttribute;
         }
     }
 }

package/src/office/mediaFiles.ts

@@ -25,41 +25,41 @@ export class MediaFiles {
      */
     public async add(mediaFile: Binary, mime: MimeType): Promise<string> {
 
-        // 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;
     }
 
@@ -84,7 +84,14 @@ export class MediaFiles {
 
             const fileData = await this.zip.getFile(path).getContentBase64();
             const fileHash = sha1(fileData);
-            this.hashes[filename] = fileHash;
+            this.hashes[path] = fileHash;
         }
     }
+
+    private baseFilename(mime: MimeType): string {
+        // Naive heuristic.
+        // May need to be modified if we're going to support more mime types.
+        const parts = mime.split('/');
+        return parts[0];
+    }
 }

package/src/plugins/image/imagePlugin.ts

@@ -48,20 +48,19 @@ export class ImagePlugin extends TemplatePlugin {
         if (!context.pluginContext[this.contentType]) {
             context.pluginContext[this.contentType] = {};
         }
-        if (!context.pluginContext[this.contentType]) {
-            context.pluginContext[this.contentType] = {};
-        }
 
         const pluginContext: ImagePluginContext = 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.
@@ -79,8 +78,8 @@ export class ImagePlugin extends TemplatePlugin {
         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];
     }
 
     private createMarkup(imageId: number, relId: string, content: ImageContent): XmlNode {

package/src/plugins/index.ts

@@ -3,6 +3,7 @@ export * from './link';
 export * from './loop';
 export * from './rawXml';
 export * from './text';
+export * from "./chart";
 export * from './defaultPlugins';
 export * from './pluginContent';
 export * from './templatePlugin';

package/src/utils/txt.ts

@@ -32,3 +32,8 @@ export function stringValue(val: unknown): string {
 export function normalizeDoubleQuotes(text: string): string {
     return text.replace(nonStandardDoubleQuotesRegex, standardDoubleQuotes);
 }
+
+export function countOccurrences(text: string, substring: string): number {
+    // https://stackoverflow.com/questions/4009756/how-to-count-string-occurrence-in-string
+    return (text.match(new RegExp(substring, 'g')) || []).length;
+}