node-pptx-templater 1.0.12 → 1.0.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-pptx-templater",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "High-performance, low-level PowerPoint (PPTX) OpenXML template engine for Node.js. Dynamically replace text, insert images, update charts (with Excel workbook data caching), and merge table cells without PowerPoint corruption or Repair Mode prompts.",
   "main": "./src/index.js",
   "type": "commonjs",

package/src/core/OutputWriter.js

@@ -26,6 +26,9 @@ class OutputWriter {
   /** @private @type {ContentTypesManager} */
   #contentTypesManager
 
+  /** @type {boolean} */
+  debugZip = false
+
   /**
    * @param {ZipManager} zipManager
    * @param {ContentTypesManager} contentTypesManager
@@ -76,6 +79,11 @@ class OutputWriter {
 
     const buffer = await zipManager.toBuffer()
     logger.debug(`Generated buffer: ${(buffer.length / 1024).toFixed(1)} KB`)
+
+    if (this.debugZip) {
+      this.printDebugZip(buffer)
+    }
+
     return buffer
   }
 
@@ -94,9 +102,68 @@ class OutputWriter {
 
     await zipManager.waitForPendingWrites()
     const nodeStream = await zipManager.toStream()
+
+    if (this.debugZip) {
+      const buffer = await zipManager.toBuffer()
+      this.printDebugZip(buffer)
+    }
+
     return nodeStream
   }
 
+  /**
+   * Parses the Central Directory of a ZIP buffer and logs debug info for every entry.
+   *
+   * @param {Buffer} buffer
+   */
+  printDebugZip(buffer) {
+    let offset = 0
+    const entries = []
+
+    while (offset < buffer.length - 46) {
+      const sig = buffer.readUInt32LE(offset)
+      if (sig === 0x02014b50) {
+        const compressionMethod = buffer.readUInt16LE(offset + 10)
+        const crc32 = buffer.readUInt32LE(offset + 16)
+        const compressedSize = buffer.readUInt32LE(offset + 20)
+        const uncompressedSize = buffer.readUInt32LE(offset + 24)
+        const fileNameLength = buffer.readUInt16LE(offset + 28)
+        const extraFieldLength = buffer.readUInt16LE(offset + 30)
+        const fileCommentLength = buffer.readUInt16LE(offset + 32)
+
+        const fileName = buffer.toString('utf8', offset + 46, offset + 46 + fileNameLength)
+
+        entries.push({
+          name: fileName,
+          compressionMethod,
+          crc32: crc32.toString(16).toLowerCase(),
+          compressedSize,
+          uncompressedSize,
+        })
+
+        offset += 46 + fileNameLength + extraFieldLength + fileCommentLength
+      } else {
+        offset++
+      }
+    }
+
+    logger.info(`--- ZIP debug output (${entries.length} entries) ---`)
+    entries.forEach(e => {
+      const methodStr =
+        e.compressionMethod === 8
+          ? 'DEFLATE'
+          : e.compressionMethod === 0
+            ? 'STORE'
+            : `UNKNOWN(${e.compressionMethod})`
+      console.log(e.name)
+      console.log(`compressed: ${e.compressedSize}`)
+      console.log(`uncompressed: ${e.uncompressedSize}`)
+      console.log(`crc: ${e.crc32}`)
+      console.log(`method: ${methodStr}`)
+    })
+    logger.info('--- End of ZIP debug output ---')
+  }
+
   /**
    * Ensures all dirty slide XML is committed to the ZipManager.
    * This is called before any output operation.
@@ -107,8 +174,6 @@ class OutputWriter {
    * @returns {Promise<void>}
    */
   async #flushAllSlides(slideManager, zipManager) {
-    // SlideManager already writes to zipManager via setSlideXml,
-    // so this is mostly a no-op with a validation step.
     const info = slideManager.getAllSlideInfo()
 
     for (const slide of info) {
@@ -117,64 +182,58 @@ class OutputWriter {
       }
     }
 
-    // Update the slide count and titles in docProps/app.xml to prevent repair mode issues
+    // Change this block to await the process completely
     if (zipManager.hasFile('docProps/app.xml')) {
-      zipManager.addPendingPromise(
-        zipManager.rawZip
-          .file('docProps/app.xml')
-          .async('text')
-          .then(content => {
-            const parser = new XMLParser()
-            const appObj = parser.parse(content, 'app.xml')
-            const properties = appObj.Properties
-
-            if (properties) {
-              // 1. Update Slides count
-              properties.Slides = info.length
-
-              // 2. Find old slide titles count and update HeadingPairs
-              let oldSlideTitlesCount = 0
-              const variants = properties.HeadingPairs?.['vt:vector']?.['vt:variant']
-              if (Array.isArray(variants)) {
-                for (let i = 0; i < variants.length; i++) {
-                  if (variants[i]['vt:lpstr'] === 'Slide Titles') {
-                    const countVar = variants[i + 1]
-                    if (countVar) {
-                      oldSlideTitlesCount = parseInt(countVar['vt:i4'], 10) || 0
-                      countVar['vt:i4'] = info.length
-                    }
-                    break
+      // AWAIT this process entirely before exiting the function!
+      await zipManager.rawZip
+        .file('docProps/app.xml')
+        .async('text')
+        .then(content => {
+          const parser = new XMLParser()
+          const appObj = parser.parse(content, 'app.xml')
+          const properties = appObj.Properties
+
+          if (properties) {
+            properties.Slides = info.length
+
+            let oldSlideTitlesCount = 0
+            const variants = properties.HeadingPairs?.['vt:vector']?.['vt:variant']
+            if (Array.isArray(variants)) {
+              for (let i = 0; i < variants.length; i++) {
+                if (variants[i]['vt:lpstr'] === 'Slide Titles') {
+                  const countVar = variants[i + 1]
+                  if (countVar) {
+                    oldSlideTitlesCount = parseInt(countVar['vt:i4'], 10) || 0
+                    countVar['vt:i4'] = info.length
                   }
+                  break
                 }
               }
+            }
 
-              // 3. Update TitlesOfParts
-              const titlesVector = properties.TitlesOfParts?.['vt:vector']
-              if (titlesVector) {
-                let lpstrs = titlesVector['vt:lpstr']
-                if (lpstrs) {
-                  if (!Array.isArray(lpstrs)) lpstrs = [lpstrs]
-
-                  // Remove the old slide titles (which are at the end)
-                  if (oldSlideTitlesCount > 0 && lpstrs.length >= oldSlideTitlesCount) {
-                    lpstrs = lpstrs.slice(0, lpstrs.length - oldSlideTitlesCount)
-                  }
-
-                  // Append new slide titles
-                  const newSlideTitles = info.map(slide => slide.title || `Slide ${slide.index}`)
-                  lpstrs.push(...newSlideTitles)
-
-                  titlesVector['vt:lpstr'] = lpstrs
-                  titlesVector['@_size'] = String(lpstrs.length)
+            const titlesVector = properties.TitlesOfParts?.['vt:vector']
+            if (titlesVector) {
+              let lpstrs = titlesVector['vt:lpstr']
+              if (lpstrs) {
+                if (!Array.isArray(lpstrs)) lpstrs = [lpstrs]
+                if (oldSlideTitlesCount > 0 && lpstrs.length >= oldSlideTitlesCount) {
+                  lpstrs = lpstrs.slice(0, lpstrs.length - oldSlideTitlesCount)
                 }
-              }
+                const newSlideTitles = info.map(slide => slide.title || `Slide ${slide.index}`)
+                lpstrs.push(...newSlideTitles)
 
-              const declaration = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
-              const updatedXml = parser.build(appObj, declaration)
-              zipManager.writeFile('docProps/app.xml', updatedXml)
+                titlesVector['vt:lpstr'] = lpstrs
+                titlesVector['@_size'] = String(lpstrs.length)
+              }
             }
-          })
-      )
+
+            const declaration = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
+            const updatedXml = parser.build(appObj, declaration)
+
+            // Writing it safely here now that the function block is strictly sequential
+            zipManager.writeFile('docProps/app.xml', updatedXml)
+          }
+        })
     }
 
     logger.debug(`Flushed ${info.length} slide(s) to ZIP`)

package/src/core/PPTXTemplater.js

@@ -987,6 +987,7 @@ class PPTXTemplater {
         )
       }
     }
+    await this.validateArchive()
     await this.#outputWriter.saveToFile(filePath, this.#slideManager, this.#zipManager)
     logger.info(`Saved PPTX to ${filePath}`)
   }
@@ -998,6 +999,7 @@ class PPTXTemplater {
    */
   async toBuffer() {
     this.#assertLoaded()
+    await this.validateArchive()
     return this.#outputWriter.toBuffer(this.#slideManager, this.#zipManager)
   }
 
@@ -1008,6 +1010,7 @@ class PPTXTemplater {
    */
   async toStream() {
     this.#assertLoaded()
+    await this.validateArchive()
     return this.#outputWriter.toStream(this.#slideManager, this.#zipManager)
   }
 
@@ -1749,6 +1752,17 @@ class PPTXTemplater {
     )
   }
 
+  async validateArchive() {
+    this.#assertLoaded()
+    await this.#zipManager.validateArchive()
+    return this
+  }
+
+  enableDebugZip() {
+    this.#outputWriter.debugZip = true
+    return this
+  }
+
   validateRelationships(partPath) {
     this.#assertLoaded()
     return ValidationEngine.validateRelationships(this, partPath)

package/src/managers/ZipManager.js

@@ -288,6 +288,97 @@ class ZipManager {
     }
   }
 
+  /**
+   * Validates the integrity of the ZIP archive.
+   * Checks for CRC integrity, entry sizes, duplicate entries, missing critical entries, and invalid binary data.
+   *
+   * @returns {Promise<void>}
+   * @throws {PPTXError} If any validation issue is found.
+   */
+  async validateArchive() {
+    const files = this.#zip.files
+    const errors = []
+    const seenPaths = new Set()
+    const { XMLParser } = require('../parsers/XMLParser.js')
+    const parser = new XMLParser()
+
+    for (const [name, file] of Object.entries(files)) {
+      if (file.dir) continue
+
+      const lowerPath = name.toLowerCase()
+      if (seenPaths.has(lowerPath)) {
+        errors.push(`Duplicate entry found (case-insensitive): ${name}`)
+      }
+      seenPaths.add(lowerPath)
+
+      try {
+        // file.async('uint8array') forces decompression and checks CRC32 & uncompressed size
+        const content = await file.async('uint8array')
+
+        // If XML/rels file, verify it's not empty and is valid XML
+        if (name.endsWith('.xml') || name.endsWith('.rels')) {
+          const { TextDecoder } = require('util')
+          const text = new TextDecoder('utf-8').decode(content)
+          if (!text.trim()) {
+            errors.push(`XML/rels entry is empty: ${name}`)
+          } else {
+            try {
+              parser.parse(text, name)
+            } catch (xmlErr) {
+              errors.push(`Invalid XML/rels structure in ${name}: ${xmlErr.message}`)
+            }
+          }
+        }
+
+        // Verify media files (like images) are not empty and have correct magic numbers
+        if (name.startsWith('ppt/media/')) {
+          if (content.length === 0) {
+            errors.push(`Media entry is empty: ${name}`)
+          }
+          const ext = name.split('.').pop().toLowerCase()
+          if (ext === 'png') {
+            if (
+              content[0] !== 0x89 ||
+              content[1] !== 0x50 ||
+              content[2] !== 0x4e ||
+              content[3] !== 0x47
+            ) {
+              errors.push(`Invalid PNG signature in media file: ${name}`)
+            }
+          } else if (ext === 'jpg' || ext === 'jpeg') {
+            if (content[0] !== 0xff || content[1] !== 0xd8) {
+              errors.push(`Invalid JPEG signature in media file: ${name}`)
+            }
+          }
+        }
+      } catch (err) {
+        errors.push(`CRC32 or uncompressed size integrity failure on entry ${name}: ${err.message}`)
+      }
+    }
+
+    // Check for critical missing OpenXML files
+    const criticalFiles = [
+      '[Content_Types].xml',
+      '_rels/.rels',
+      'ppt/presentation.xml',
+      'ppt/_rels/presentation.xml.rels',
+    ]
+
+    for (const critical of criticalFiles) {
+      if (!this.hasFile(critical)) {
+        errors.push(`Critical OpenXML package file is missing: ${critical}`)
+      }
+    }
+
+    if (errors.length > 0) {
+      throw new PPTXError(
+        `ZIP archive validation failed:\n${errors.map(e => `  • ${e}`).join('\n')}`
+      )
+    }
+
+    logger.info('ZIP archive integrity validation passed.')
+  }
+
   /**
    * Returns the raw JSZip instance (for advanced use cases).
    * @returns {JSZip}

package/src/managers/charts/ChartCacheGenerator.js

@@ -350,7 +350,9 @@ class ChartCacheGenerator {
             if (dLblTxPrMatch) {
               existingDLblTxPrs[idx] = dLblTxPrMatch[1]
             }
-            const dLblLayoutMatch = /(<c:layout>[\s\S]*?<\/c:layout>|<c:layout\/>)/.exec(dLblContent)
+            const dLblLayoutMatch = /(<c:layout>[\s\S]*?<\/c:layout>|<c:layout\/>)/.exec(
+              dLblContent
+            )
             if (dLblLayoutMatch) {
               existingDLblLayouts[idx] = dLblLayoutMatch[1]
             }