docxRaw support to get xml from inline string in docx

fix #1024
jsreport · Oct 30, 2023 · d615661 · d615661
1 parent 31687cc
commit d615661
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 8 deletions.
diff --git a/packages/jsreport-docx/lib/decodeXML.js b/packages/jsreport-docx/lib/decodeXML.js
@@ -0,0 +1,5 @@
+const { decode } = require('html-entities')
+
+module.exports = function decodeXML (str) {
+  return decode(str, { level: 'xml' })
+}
diff --git a/packages/jsreport-docx/lib/preprocess/raw.js b/packages/jsreport-docx/lib/preprocess/raw.js
@@ -27,6 +27,14 @@ module.exports = (files) => {
       if (!replaceParentElementArg || !replaceParentElementArg[1]) {
         throw new Error('Expected "replaceParentElement" parameter for the docxRaw helper')
       }
+      const rawXML = xmlArg[1]
+
+      // if the xml was specified inline, it means it was stored as part of the xml,
+      // in this case we need to decode the XML at runtime, we specify that by using the inlineXML option
+      if (rawXML.startsWith("'") || rawXML.startsWith('"')) {
+        textEl.textContent = `${textEl.textContent.slice(0, xmlArg.index)}inlineXML=true ${textEl.textContent.slice(xmlArg.index)}`
+      }
+
       const replaceParentElement = replaceParentElementArg[1]
       const helperCall = textEl.textContent.match(regexp)[0]
       const newNode = documentFile.createElement('docxRemove')

diff --git a/packages/jsreport-docx/lib/processDocx.js b/packages/jsreport-docx/lib/processDocx.js
@@ -1,12 +1,11 @@
 const { DOMParser, XMLSerializer } = require('@xmldom/xmldom')
 const { customAlphabet } = require('nanoid')
-const { decode } = require('html-entities')
 const { decompress, saveXmlsToOfficeFile } = require('@jsreport/office')
 const preprocess = require('./preprocess/preprocess.js')
 const postprocess = require('./postprocess/postprocess.js')
 const { contentIsXML } = require('./utils')
+const decodeXML = require('./decodeXML')
 const generateRandomId = customAlphabet('ABCDEFGHIJKLMNOPQRSTUVWXYZ', 4)
-const decodeXML = (str) => decode(str, { level: 'xml' })
 
 module.exports = async (reporter, inputs, req) => {
   const { docxTemplateContent, options, outputPath } = inputs

diff --git a/packages/jsreport-docx/lib/worker.js b/packages/jsreport-docx/lib/worker.js
@@ -14,6 +14,11 @@ module.exports = (reporter, definition) => {
 
   let helpersScript
 
+  reporter.options.sandbox.modules.push({
+    alias: 'docxDecodeXML',
+    path: path.join(__dirname, './decodeXML.js')
+  })
+
   reporter.options.sandbox.modules.push({
     alias: 'docxProcessChildEmbed',
     path: path.join(__dirname, './processChildEmbed/index.js')

diff --git a/packages/jsreport-docx/static/helpers.js b/packages/jsreport-docx/static/helpers.js
@@ -1,7 +1,6 @@
 /* eslint no-unused-vars: 0 */
 /* eslint no-new-func: 0 */
 /* *global __rootDirectory */
-
 function docxContext (options) {
   const Handlebars = require('handlebars')
   let data
@@ -58,15 +57,20 @@ function docxPageBreak () {
 
 function docxRaw (options) {
   const Handlebars = require('handlebars')
+  const isInlineXML = options.hash.inlineXML === true
+  let xmlInput = options.hash.xml
 
-  if (typeof options.hash.xml === 'string') {
-    if (options.hash.xml.startsWith('<')) {
-      return new Handlebars.SafeString(options.hash.xml)
-    }
+  if (isInlineXML && typeof xmlInput === 'string') {
+    const decodeXML = require('docxDecodeXML')
+    xmlInput = decodeXML(xmlInput)
+  }
+
+  if (typeof xmlInput === 'string' && xmlInput.startsWith('<')) {
+    return new Handlebars.SafeString(xmlInput)
   }
 
   // Wrap not valid XML data as a literal, without any style
-  return new Handlebars.SafeString('<w:r><w:t>' + options.hash.xml + '</w:t></w:r>')
+  return new Handlebars.SafeString('<w:r><w:t>' + xmlInput + '</w:t></w:r>')
 }
 
 function docxList (data, options) {

diff --git a/packages/jsreport-docx/test/docx/raw-inline.docx b/packages/jsreport-docx/test/docx/raw-inline.docx
diff --git a/packages/jsreport-docx/test/rawTest.js b/packages/jsreport-docx/test/rawTest.js
@@ -125,6 +125,38 @@ describe('docx raw', () => {
     ])
   })
 
+  it('raw with inline xml parameter', async () => {
+    const result = await reporter.render({
+      template: {
+        engine: 'handlebars',
+        recipe: 'docx',
+        docx: {
+          templateAsset: {
+            content: fs.readFileSync(path.join(docxDirPath, 'raw-inline.docx'))
+          }
+        }
+      },
+      data: {}
+    })
+
+    // Write document for easier debugging
+    fs.writeFileSync(outputPath, result.content)
+
+    const [doc] = await getDocumentsFromDocxBuf(result.content, ['word/document.xml'])
+    const generalTextElements = nodeListToArray(doc.getElementsByTagName('w:t'))
+
+    const found = []
+    for (const textEl of generalTextElements) {
+      if (textEl.textContent.includes('raw xml run')) {
+        found.push(textEl.textContent)
+        should(textEl.parentNode.nodeName).eql('w:r', textEl.textContent)
+        should(textEl.parentNode.parentNode.nodeName).eql('w:p', textEl.textContent)
+        should(textEl.parentNode.parentNode.parentNode.nodeName).eql('w:body', textEl.textContent)
+      }
+    }
+    should(found).eql(['raw xml run'])
+  })
+
   it('raw error no parameter', async () => {
     const result = reporter.render({
       template: {