@jsreport/jsreport-core 3.0.0 → 3.1.2-test.1

package/lib/shared/reporter.js

@@ -1,123 +1,128 @@
-const EventEmitter = require('events')
-const ListenerCollection = require('listener-collection')
-const Request = require('./request')
-const Templates = require('./templates')
-const Folders = require('./folders')
-const createOrExtendError = require('./createError')
-const tempFilesHandler = require('./tempFilesHandler')
-const encryption = require('./encryption')
-
-class Reporter extends EventEmitter {
-  constructor (options) {
-    super()
-
-    this.options = options || {}
-    this.Request = Request
-
-    // since `reporter` instance will be used for other extensions,
-    // it will quickly reach the limit of `10` listeners,
-    // we increase the limit to Infinity for now,
-    // later we should probably design
-    // a way to detect possible memory leaks from extensions
-    this.setMaxListeners(Infinity)
-
-    const coreVersion = require('../../package.json').version
-
-    this.version = coreVersion
-    this.coreVersion = coreVersion
-
-    this.initializeListeners = this.createListenerCollection()
-    this.afterRenderListeners = this.createListenerCollection()
-    this.renderErrorListeners = this.createListenerCollection()
-    this.beforeRenderListeners = this.createListenerCollection()
-    this.closeListeners = this.createListenerCollection()
-  }
-
-  createListenerCollection () {
-    return new ListenerCollection()
-  }
-
-  /**
-   *  Creates a custom error or extends an existing one
-   *
-   * @public
-   */
-  createError (message, options = {}) {
-    return createOrExtendError(message, options)
-  }
-
-  /**
-   * Ensures that the jsreport autocleanup temp directory (options.tempAutoCleanupDirectory) exists by doing a mkdir call
-   *
-   * @public
-   */
-  async ensureTempDirectoryExists () {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use ensureTempDirectoryExists when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.ensureTempDirectoryExists(this.options.tempAutoCleanupDirectory)
-  }
-
-  /**
-   * Reads a file from the jsreport autocleanup temp directory (options.tempAutoCleanupDirectory)
-   *
-   * @public
-   */
-  async readTempFile (filename, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use readTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.readTempFile(this.options.tempAutoCleanupDirectory, filename, opts)
-  }
-
-  /**
-   * Creates a file into the jsreport autocleanup temp directory (options.tempAutoCleanupDirectory)
-   * ensuring that the directory always exists
-   *
-   * @public
-   */
-  async writeTempFile (filenameFn, content, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use writeTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.writeTempFile(this.options.tempAutoCleanupDirectory, filenameFn, content, opts)
-  }
-
-  /**
-   * Reads a file as stream from the jsreport autocleanup temp directory (options.tempAutoCleanupDirectory)
-   *
-   * @public
-   */
-  async readTempFileStream (filename, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use readTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.readTempFileStream(this.options.tempAutoCleanupDirectory, filename, opts)
-  }
-
-  /**
-   * Creates a file as stream into the jsreport autocleanup temp directory (options.tempAutoCleanupDirectory)
-   * ensuring that the directory always exists
-   *
-   * @public
-   */
-  async writeTempFileStream (filenameFn, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use writeTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.writeTempFileStream(this.options.tempAutoCleanupDirectory, filenameFn, opts)
-  }
-
-  async init () {
-    this.templates = Templates(this)
-    this.folders = Folders(this)
-    this.encryption = encryption(this)
-  }
-}
-
-module.exports = Reporter
+const EventEmitter = require('events')
+const createListenerCollection = require('./listenerCollection')
+const Request = require('./request')
+const Templates = require('./templates')
+const Folders = require('./folders')
+const createOrExtendError = require('./createError')
+const tempFilesHandler = require('./tempFilesHandler')
+const encryption = require('./encryption')
+const generateRequestId = require('../shared/generateRequestId')
+
+class Reporter extends EventEmitter {
+  constructor (options) {
+    super()
+
+    this.options = options || {}
+    this.Request = Request
+
+    // since `reporter` instance will be used for other extensions,
+    // it will quickly reach the limit of `10` listeners,
+    // we increase the limit to Infinity for now,
+    // later we should probably design
+    // a way to detect possible memory leaks from extensions
+    this.setMaxListeners(Infinity)
+
+    const coreVersion = require('../../package.json').version
+
+    this.version = coreVersion
+    this.coreVersion = coreVersion
+
+    this.initializeListeners = this.createListenerCollection('initialize')
+    this.afterRenderListeners = this.createListenerCollection('afterRender')
+    this.renderErrorListeners = this.createListenerCollection('renderError')
+    this.beforeRenderListeners = this.createListenerCollection('beforeRender')
+    this.closeListeners = this.createListenerCollection('close')
+  }
+
+  createListenerCollection (name) {
+    return createListenerCollection(name)
+  }
+
+  /**
+   *  Creates a custom error or extends an existing one
+   *
+   * @public
+   */
+  createError (message, options = {}) {
+    return createOrExtendError(message, options)
+  }
+
+  generateRequestId () {
+    return generateRequestId()
+  }
+
+  /**
+   * Ensures that the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory) exists by doing a mkdir call
+   *
+   * @public
+   */
+  async ensureTempDirectoryExists () {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use ensureTempDirectoryExists when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.ensureTempDirectoryExists(this.options.tempAutoCleanupDirectory)
+  }
+
+  /**
+   * Reads a file from the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   *
+   * @public
+   */
+  async readTempFile (filename, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use readTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.readTempFile(this.options.tempAutoCleanupDirectory, filename, opts)
+  }
+
+  /**
+   * Creates a file into the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   * ensuring that the directory always exists
+   *
+   * @public
+   */
+  async writeTempFile (filenameFn, content, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use writeTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.writeTempFile(this.options.tempAutoCleanupDirectory, filenameFn, content, opts)
+  }
+
+  /**
+   * Reads a file as stream from the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   *
+   * @public
+   */
+  async readTempFileStream (filename, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use readTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.readTempFileStream(this.options.tempAutoCleanupDirectory, filename, opts)
+  }
+
+  /**
+   * Creates a file as stream into the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   * ensuring that the directory always exists
+   *
+   * @public
+   */
+  async writeTempFileStream (filenameFn, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use writeTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.writeTempFileStream(this.options.tempAutoCleanupDirectory, filenameFn, opts)
+  }
+
+  async init () {
+    this.templates = Templates(this)
+    this.folders = Folders(this)
+    this.encryption = encryption(this)
+  }
+}
+
+module.exports = Reporter

package/lib/shared/request.js

@@ -1,64 +1,64 @@
-const extend = require('node.extend.without.arrays')
-const omit = require('lodash.omit')
-
-module.exports = (obj, parent) => {
-  if (parent && !parent.__isJsreportRequest__) {
-    throw new Error('Invalid parent request passed')
-  }
-
-  const request = Object.create({}, {
-    __isJsreportRequest__: {
-      value: true,
-      writable: false,
-      configurable: false,
-      enumerable: false
-    }
-  })
-
-  request.template = extend(true, {}, obj.template)
-
-  if (parent) {
-    request.context = Object.assign({}, request.context, omit(parent.context, ['id', 'logs', 'systemHelpers']))
-    request.context.isChildRequest = true
-    request.options = Object.assign({}, request.options, parent.options)
-
-    if (parent.data) {
-      const dataInput = normalizeJSONData(parent.data)
-      request.data = Object.assign(Array.isArray(dataInput) ? [] : {}, dataInput)
-    }
-  }
-
-  request.options = extend(true, {}, request.options, obj.options)
-  request.context = extend(true, {}, request.context, obj.context)
-  request.context.shared = extend(true, {}, request.context.shared)
-
-  if (obj.data) {
-    const dataInput = normalizeJSONData(obj.data)
-    request.data = Object.assign(Array.isArray(dataInput) ? [] : {}, request.data, dataInput)
-
-    // don't override value if it was already set by caller
-    if (obj.context == null || obj.context.originalInputDataIsEmpty == null) {
-      request.context.originalInputDataIsEmpty = false
-    }
-  } else if (!parent) {
-    // don't override value if it was already set by caller
-    if (obj.context == null || obj.context.originalInputDataIsEmpty == null) {
-      request.context.originalInputDataIsEmpty = true
-    }
-  }
-
-  // initialize data if it is empty
-  if (!request.data) {
-    request.data = {}
-  }
-
-  return request
-}
-
-function normalizeJSONData (data) {
-  if (typeof data === 'string') {
-    return JSON.parse(data)
-  }
-
-  return data
-}
+const extend = require('node.extend.without.arrays')
+const omit = require('lodash.omit')
+
+module.exports = (obj, parent) => {
+  if (parent && !parent.__isJsreportRequest__) {
+    throw new Error('Invalid parent request passed')
+  }
+
+  const request = Object.create({}, {
+    __isJsreportRequest__: {
+      value: true,
+      writable: false,
+      configurable: false,
+      enumerable: false
+    }
+  })
+
+  request.template = extend(true, {}, obj.template)
+
+  if (parent) {
+    request.context = Object.assign({}, request.context, omit(parent.context, ['id', 'logs', 'systemHelpers']))
+    request.context.isChildRequest = true
+    request.options = Object.assign({}, request.options, parent.options)
+
+    if (parent.data) {
+      const dataInput = normalizeJSONData(parent.data)
+      request.data = Object.assign(Array.isArray(dataInput) ? [] : {}, dataInput)
+    }
+  }
+
+  request.options = extend(true, {}, request.options, obj.options)
+  request.context = extend(true, {}, request.context, obj.context)
+  request.context.shared = extend(true, {}, request.context.shared)
+
+  if (obj.data) {
+    const dataInput = normalizeJSONData(obj.data)
+    request.data = Object.assign(Array.isArray(dataInput) ? [] : {}, request.data, dataInput)
+
+    // don't override value if it was already set by caller
+    if (obj.context == null || obj.context.originalInputDataIsEmpty == null) {
+      request.context.originalInputDataIsEmpty = false
+    }
+  } else if (!parent) {
+    // don't override value if it was already set by caller
+    if (obj.context == null || obj.context.originalInputDataIsEmpty == null) {
+      request.context.originalInputDataIsEmpty = true
+    }
+  }
+
+  // initialize data if it is empty
+  if (!request.data) {
+    request.data = {}
+  }
+
+  return request
+}
+
+function normalizeJSONData (data) {
+  if (typeof data === 'string') {
+    return JSON.parse(data)
+  }
+
+  return data
+}

package/lib/shared/tempFilesHandler.js

@@ -1,81 +1,81 @@
-const path = require('path')
-const fs = require('fs')
-const fsAsync = require('fs/promises')
-const { v4: uuidv4 } = require('uuid')
-
-module.exports.ensureTempDirectoryExists = async function (tempDirectory) {
-  await fsAsync.mkdir(tempDirectory, {
-    recursive: true
-  })
-
-  return {
-    directoryPath: tempDirectory
-  }
-}
-
-module.exports.readTempFile = async function readTempFile (tempDirectory, filename, opts = {}) {
-  const pathToFile = path.join(tempDirectory, filename)
-
-  const content = await fsAsync.readFile(pathToFile, opts)
-
-  return {
-    pathToFile,
-    filename,
-    content
-  }
-}
-
-module.exports.readTempFileStream = async function readTempFileStream (tempDirectory, filename, opts = {}) {
-  const pathToFile = path.join(tempDirectory, filename)
-
-  return new Promise((resolve) => {
-    const stream = fs.createReadStream(pathToFile, opts)
-
-    resolve({
-      pathToFile,
-      filename,
-      stream
-    })
-  })
-}
-
-module.exports.writeTempFile = async function writeTempFile (tempDirectory, filenameFn, content, opts = {}) {
-  return writeFile(tempDirectory, filenameFn, content, opts)
-}
-
-module.exports.writeTempFileStream = async function writeTempFileStream (tempDirectory, filenameFn, opts = {}) {
-  return writeFile(tempDirectory, filenameFn, undefined, opts, true)
-}
-
-async function writeFile (tempDirectory, filenameFn, content, opts, asStream = false) {
-  const filename = filenameFn(uuidv4())
-
-  if (filename == null || filename === '') {
-    throw new Error('No valid filename was returned from filenameFn')
-  }
-
-  const pathToFile = path.join(tempDirectory, filename)
-
-  await fsAsync.mkdir(tempDirectory, {
-    recursive: true
-  })
-
-  if (asStream === true) {
-    return new Promise((resolve) => {
-      const stream = fs.createWriteStream(pathToFile, opts)
-
-      resolve({
-        pathToFile,
-        filename,
-        stream
-      })
-    })
-  } else {
-    await fsAsync.writeFile(pathToFile, content, opts)
-
-    return {
-      pathToFile,
-      filename
-    }
-  }
-}
+const path = require('path')
+const fs = require('fs')
+const fsAsync = require('fs/promises')
+const { v4: uuidv4 } = require('uuid')
+
+module.exports.ensureTempDirectoryExists = async function (tempDirectory) {
+  await fsAsync.mkdir(tempDirectory, {
+    recursive: true
+  })
+
+  return {
+    directoryPath: tempDirectory
+  }
+}
+
+module.exports.readTempFile = async function readTempFile (tempDirectory, filename, opts = {}) {
+  const pathToFile = path.join(tempDirectory, filename)
+
+  const content = await fsAsync.readFile(pathToFile, opts)
+
+  return {
+    pathToFile,
+    filename,
+    content
+  }
+}
+
+module.exports.readTempFileStream = async function readTempFileStream (tempDirectory, filename, opts = {}) {
+  const pathToFile = path.join(tempDirectory, filename)
+
+  return new Promise((resolve) => {
+    const stream = fs.createReadStream(pathToFile, opts)
+
+    resolve({
+      pathToFile,
+      filename,
+      stream
+    })
+  })
+}
+
+module.exports.writeTempFile = async function writeTempFile (tempDirectory, filenameFn, content, opts = {}) {
+  return writeFile(tempDirectory, filenameFn, content, opts)
+}
+
+module.exports.writeTempFileStream = async function writeTempFileStream (tempDirectory, filenameFn, opts = {}) {
+  return writeFile(tempDirectory, filenameFn, undefined, opts, true)
+}
+
+async function writeFile (tempDirectory, filenameFn, content, opts, asStream = false) {
+  const filename = filenameFn(uuidv4())
+
+  if (filename == null || filename === '') {
+    throw new Error('No valid filename was returned from filenameFn')
+  }
+
+  const pathToFile = path.join(tempDirectory, filename)
+
+  await fsAsync.mkdir(tempDirectory, {
+    recursive: true
+  })
+
+  if (asStream === true) {
+    return new Promise((resolve) => {
+      const stream = fs.createWriteStream(pathToFile, opts)
+
+      resolve({
+        pathToFile,
+        filename,
+        stream
+      })
+    })
+  } else {
+    await fsAsync.writeFile(pathToFile, content, opts)
+
+    return {
+      pathToFile,
+      filename
+    }
+  }
+}