xlsx-template-browser 0.2.0 → 0.3.0

package/lib/helpers.js

@@ -1,63 +0,0 @@
-/**
- * Downloads a file using the provided data and file name.
- * @param {string} data - The file data
- * @param {string} fileName - The desired name for the downloaded file
- */
-
-const downloadURL = (data, fileName) => {
-  const a = document.createElement('a')
-  a.href = data
-  a.download = fileName
-  a.style = 'display: none'
-  document.body.appendChild(a)
-  a.click()
-  a.remove()
-}
-
-/**
- * Converts an array to a Blob and initiates the download with the specified file name and MIME type.
- * @param {Array} data - The array data to be converted to a Blob.
- * @param {string} fileName - The desired name for the downloaded file.
- * @param {string} mimeType - The MIME type of the file.
- */
-export const downloadBlob = (data, fileName, mimeType) => {
-  const blob = new Blob([data], { type: mimeType })
-  const url = window.URL.createObjectURL(blob)
-  downloadURL(url, fileName)
-  setTimeout(() => { return window.URL.revokeObjectURL(url) }, 100)
-}
-
-
-// Regular expression for extracting fields with deep notation data
-const notationRegex = /(?<=\[(?<qoute>['"]))[^'"\]].*?(?=\k<qoute>\])|(?<=\[)[^'"\]].*?(?=\])|[^.\["''\]]+(?=\.|\[|$)/g
-
-/**
- * Retrieves nested properties from an object using an array of accessors.
- * @param {*} obj - The object from which to retrieve the nested properties.
- * @param {Array} accessors - An array of accessors representing the path to the desired properties.
- * @returns {*} - The value of the nested properties, or undefined if any accessor along the path is undefined.
- */
-const getDeep = (obj, accessors) => {
-  let length = accessors.length
-  for (let i = 0; i < length; i++) {
-    if (typeof obj === 'undefined') return undefined
-    if (Array.isArray(obj) && typeof accessors[i] === 'string') return obj.map(el => getDeep(el, accessors.slice(i)))
-    obj = obj[accessors[i]]
-  }
-  return obj
-}
-
-/**
- * Retrieves nested properties from an object using dot and bracket notation.
- * @param {*} obj - The object from which to retrieve the nested properties.
- * @param {string} props - The notation representing the path to the desired properties.
- * @returns {*} - The value of the nested properties, or the original object if the notation is empty.
- */
-export const getByNotation = (obj, props) => {
-  let accessors = props.match(notationRegex)
-  if (!accessors.length) return obj
-  accessors = accessors.map(el => /^\d+$/.test(el) ? parseInt(el) : el)
-  const value = getDeep(obj, accessors)
-  return value || ''
-}
-

package/lib/index.js

@@ -1,31 +0,0 @@
-import { downloadBlob } from './helpers'
-import replace from './main'
-
-/**
- * Generates an XLSX file by replacing data in a template file.
- * @param {string} templateURL - The URL of the template XLSX file.
- * @param {Object} data - The data object containing values to replace in the template.
- * @returns {Promise<Blob>} A promise that resolves with the Blob of the generated XLSX file.
- * @throws {Error} Throws an error if either the template URL or data is not provided, or if unable to fetch the template file.
- */
-export const generateXlsx = async (template, data) => {
-  if (!template || !data) throw Error('No template or data provided')
-  if (typeof template === 'string' && template.match(/^https?:/)) {
-    const response = await fetch(template).catch(err => { return false})
-    if (!response) throw Error('Can\'t fetch the template URL')
-    template = response.arrayBuffer()
-  }
-  return await replace(template, data)
-}
-
-/**
- * Downloads an XLSX file by replacing data in a template file and initiates the download in the browser.
- * @param {string} templateURL - The URL of the template XLSX file.
- * @param {Object} data - The data object containing values to replace in the template.
- * @param {string} [fileName] - The name of the file to be downloaded. If not provided, a default name based on the current date will be used.
- * @returns {Promise<void>} A promise that resolves once the download is initiated.
- */
-export const downloadXlsx = async (template, data, fileName, mimeType) => {
-  if (!fileName) fileName = new Date().toISOString().substring(0, 10) + ' - Report.xlsx'
-  downloadBlob(await generateXlsx(template, data), fileName, mimeType)
-}

package/lib/main.js

@@ -1,289 +0,0 @@
-// Refer to Excel OpenXML format:
-// https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.spreadsheet.cell?view=openxml-2.8.1
-
-// Import JSZip library for working with ZIP files
-import JSZip from 'jszip'
-import {
-  createCell,
-  createSharedString,
-  getExcelColumnIndex,
-  guessDataType,
-  valueToString
-} from './excelHelpers'
-
-import {
-  getByNotation
-} from './helpers'
-
-// Regular expression for parsing a property accessor enclosed in ${}
-const accessorRegex = /(?<=^\$\{)(?<table>table:)?(?<accessor>[^}]+)(?=}$)/
-
-// Global regular expression for extracting all property accessors enclosed in ${}
-const globalAccessorRegex = /\$\{[^}]+}/g
-
-const replace = async (template, data) => {
-  if (!template || !data) return template
-
-  /* INITIALIZATION */
-
-  // Create a new DOMParser instance for parsing XML. Refer to https://developer.mozilla.org/en-US/docs/Web/API/DOMParser
-  const parser = new DOMParser()
-  const serializer = new XMLSerializer()
-  // Create a new instance of JSZip for ZIP file manipulation
-  const new_zip = new JSZip()
-  // Load xlsx (zipped file)
-  let res = await new_zip.loadAsync(template)
-
-  /* Add custom style for dates */
-  const xmlStyle = await res.file('xl/styles.xml').async('string')
-  const domStyle = parser.parseFromString(xmlStyle, 'application/xml')
-
-  // Create date number format
-  const styleSheet = domStyle.querySelector('styleSheet')
-  let numFmts = domStyle.querySelector('numFmts')
-  if (!numFmts) numFmts = document.createElementNS(null, 'numFmts')
-  let numFmt = document.createElementNS(null, 'numFmt')
-  numFmt.setAttributeNS(null, 'numFmtId', '166')
-  numFmt.setAttributeNS(null, 'formatCode', 'yyyy\\-mm\\-dd;@')
-  let oldNumFmt = domStyle.querySelectorAll('numFmt')
-  let count = 0
-  const newNumFmts = numFmts.cloneNode()
-  oldNumFmt.forEach(numFmt => {
-    newNumFmts.append(numFmt)
-    count++
-  })
-  newNumFmts.append(numFmt)
-  count++
-  newNumFmts.setAttribute('count', count)
-  styleSheet.prepend(newNumFmts)
-
-  // Add a style for the date format
-  const cellXfs = domStyle.querySelector('cellXfs')
-  const xf = document.createElement('xf')
-  xf.setAttributeNS(null, 'numFmtId', 166)
-  xf.setAttributeNS(null, 'fontId', 0)
-  xf.setAttributeNS(null, 'fillId', 0)
-  xf.setAttributeNS(null, 'borderId', 0)
-  xf.setAttributeNS(null, 'xfId', 0)
-  xf.setAttributeNS(null, 'applyNumberFormat', 1)
-  const oldXf = domStyle.querySelectorAll('cellXfs xf')
-  count = 0
-  const newCellXfs = cellXfs.cloneNode()
-  oldXf.forEach(xf => {
-    newCellXfs.append(xf)
-    count++
-  })
-  count++
-  newCellXfs.append(xf)
-  newCellXfs.setAttribute('count', count)
-  const dateStyle = count - 1
-  cellXfs.replaceWith(newCellXfs)
-  const newXfData = serializer.serializeToString(domStyle).replace(/ ?xmlns="(http:\/\/www\.w3\.org\/1999\/xhtml)?"/g, '')
-  // Save new shared strings
-  await new_zip.file('xl/styles.xml', newXfData)
-
-  /* PROCESSING OF THE SHARED STRINGS */
-
-  // Read all shared text values
-  let xmlText = await res.file('xl/sharedStrings.xml').async('string')
-  // Get the xml with shared shared strings
-  const xml = parser.parseFromString(xmlText, 'application/xml')
-  // Get the header of shared strings
-  const sst = xml.querySelector('sst')
-  // Array with new values
-  const valuesToReplace = []
-  // New list of shared string values
-  let newSharedStrings = []
-
-  // We need to replace only text values with the new ones, therefore we process shared strings first
-  // Get all string items
-  xml.querySelectorAll('si').forEach((si, i) => {
-    // Get all rich format tags
-    const r = si.querySelector('r')
-    if (r) {
-      const xmlString = si.innerHTML
-      const newString = xmlString.replace(globalAccessorRegex, s => valueToString(getByNotation(data, s.replace(/\$\{|}/g, ''))))
-      si.innerHTML = newString
-      newSharedStrings.push(si)
-      valuesToReplace[i] = { value: newSharedStrings.length - 1, cellType: 's' }
-      return false
-    }
-    // Get all text tags
-    const t = si.querySelector('t')
-    if (!t) return false
-    // Get text value
-    const textValue = t.textContent
-    // Get all accessors
-    let match = textValue.match(accessorRegex)
-    // If the cell does not contain only one placeholder, check for multiple ones
-    if (!match) {
-      // Check if the text contains any accessors at all
-      let newText = textValue.replace(globalAccessorRegex, s => valueToString(getByNotation(data, s.replace(/\$\{|}/g, ''))))
-      newSharedStrings.push(createSharedString(newText, si))
-      valuesToReplace[i] = { value: newSharedStrings.length - 1, cellType: 's' }
-      return false
-    }
-    // Process a value with an accessor only
-    let { accessor, table } = match.groups
-    // If we have table values, we need to process them in a separate way
-    const isTable = typeof table === 'string'
-    let value = getByNotation(data, accessor)
-    if (typeof value === 'undefined') return false
-    // Save tables for further processing
-    if (isTable) {
-      if (!value) value = []
-      valuesToReplace[i] = { isTable, value: value.map(el => guessDataType(el, { dateStyle })) }
-      return false
-    }
-    if (Array.isArray(value)) {
-      valuesToReplace[i] = value.map(el => guessDataType(el, { dateStyle }))
-      return false
-    }
-    valuesToReplace[i] = guessDataType(value, { dateStyle })
-  })
-
-  /* PROCESSING OF WORKSHEETS */
-
-  // To prevent string duplication, store unique strings (they will be added to shared strings)
-  const newStrings = []
-
-  // Adds a string to the collection, avoiding duplication, and returns its index.
-  const addString = (value) => {
-    let stringIndex = newStrings.indexOf(value)
-    if (stringIndex === -1) {
-      newStrings.push(value)
-      stringIndex = newStrings.length - 1
-    }
-    value = stringIndex + newSharedStrings.length
-    return value
-  }
-
-  // Get all worksheets
-  const worksheets = Object.keys(res.files).filter(el => /xl\/worksheets\/[^/]+$/.test(el))
-  for (let worksheet of worksheets) {
-    // Unzip the file
-    let xmlText = await res.file(worksheet).async('string')
-    // Parse file to DOM
-    let xml = parser.parseFromString(xmlText, 'application/xml')
-    // Process rows
-    let rows = xml.querySelectorAll('sheetData row')
-    // Array with the list of the new rows
-    const newRows = []
-    // Process cells in rows
-    let rowOffset = 0
-    for (let row of rows) {
-      // Since some rows can be skipped, we want to get an actual row number from the template
-      let currentRow = parseInt(row.getAttribute('r'))
-      // List of new cells
-      let newCells = []
-      // If we have an array of values to extend the list of cells, we should keep an offset to move static cells
-      let cellOffset = 0
-      // Process each cell
-      let cells = row.querySelectorAll('c').forEach((c) => {
-        // Current cell index (note that Excel has 1-based index)
-        let index = getExcelColumnIndex(c.getAttribute('r'))
-        let newIndex = index + cellOffset
-        // Get the cell value tag
-        let v = c.querySelector('v') || {}
-        // Check if the cell contains formula, and skip
-        let isFormula = c.querySelector('f')
-        if (isFormula) {
-          const value = c
-          const cellType = 'f'
-          newCells[newIndex] = Object.assign({}, { value, cellType }, { template: c })
-          return false
-        }
-        // Check if the cell contains string
-        let isString = c.getAttribute('t')
-        if (!isString || isString !== 's') {
-          newCells[newIndex] = Object.assign({}, { template: c })
-          return false
-        }
-        // Get the new value to replace
-        let newValue = valuesToReplace[v.textContent] || {}
-        if (!Array.isArray(newValue)) {
-          let { value, cellType, style, isTable } = newValue
-          // If the new value is an array from the table, then return an array of values
-          if (isTable) {
-            newCells[newIndex] = value.map(el => {
-              if (!el) return { template: c }
-              if (el.cellType === 's' && typeof el.value === 'string') el.value = addString(el.value)
-              return { value: el.value, cellType: el.cellType, style: el.style, template: c }
-            })
-            return false
-          }
-          // Return a new value
-          if (cellType === 's' && typeof value === 'string') value = addString(value)
-          newCells[newIndex] = Object.assign({}, { value, cellType, style }, { template: c })
-          return false
-        }
-        // If the value is an array (not from table), then extend the existing list of cells
-        for (let i = 0; i < newValue.length; i++) {
-          let { value, cellType, style } = newValue[i] || {}
-          if (cellType === 's' && typeof value === 'string') value = addString(value)
-          newCells[newIndex + i] = Object.assign({}, { value, cellType, style }, { template: c })
-          if (i) cellOffset++
-        }
-      })
-
-      /*  GENERATION OF THE NEW ROWS */
-
-      // Check if the row contains arrays and the values should be duplicated
-      let length = Math.max(...newCells.filter(el => Array.isArray(el)).map(el => el.length))
-
-      // Create a row
-      if (length <= 0) {
-        let rowIndex = rowOffset + currentRow
-        const rowValues = newCells.map((el, i) => {
-          if (!el) return undefined
-          return createCell(Object.assign({}, el, { row: rowIndex, column: i }))
-        }).filter(Boolean)
-        const newRow = row.cloneNode()
-        newRow.setAttribute('r', rowIndex)
-        rowValues.forEach(value => newRow.append(value))
-        newRows.push(newRow)
-        continue
-      }
-
-      // Create table rows
-      for (let i = 0; i < length; i++) {
-        let rowIndex = rowOffset + currentRow
-        rowOffset++
-        const rowValues = newCells.map((el, index) => {
-          if (!el) return undefined
-          if (Array.isArray(el)) {
-            if (typeof el[i] === 'undefined') return undefined
-            return createCell(Object.assign({}, el[i], { row: rowIndex, column: index }))
-          }
-          return createCell(Object.assign({}, el, { row: rowIndex, column: index }))
-        })
-        const newRow = row.cloneNode()
-        newRow.setAttribute('r', rowIndex)
-        rowValues.forEach(value => {
-          if (value) newRow.append(value)
-        })
-        newRows.push(newRow)
-      }
-    }
-
-    // Generate new sheet data
-    const newSheetData = xml.querySelector('sheetData').cloneNode()
-    newRows.forEach(row => newSheetData.append(row))
-    xml.querySelector('sheetData').replaceWith(newSheetData)
-    const newData = serializer.serializeToString(xml).replace(/ ?xmlns="http:\/\/www\.w3\.org\/1999\/xhtml"/g, '')
-    // Save the data of the worksheet
-    await new_zip.file(worksheet, newData)
-  }
-
-  /* FINALIZE NEW SHARED STRINGS */
-  newSharedStrings = [...newSharedStrings, ...newStrings.map(el => createSharedString(el))]
-  const newSst = sst.cloneNode()
-  newSharedStrings.forEach(si => newSst.append(si))
-  sst.replaceWith(newSst)
-  const newData = serializer.serializeToString(xml).replace(/ ?xmlns="http:\/\/www\.w3\.org\/1999\/xhtml"/g, '')
-  // Save new shared strings
-  await new_zip.file('xl/sharedStrings.xml', newData)
-  return await new_zip.generateAsync({ type: 'blob' })
-}
-
-export default replace